Sets the ESSBASEPATH environment variable for the runtime process.
Syntax
ESS_FUNC_M EssSetPath (pszPath);
Parameter | Data Type | Description |
---|---|---|
pszPath; | ESS_STR_T | Pointer to the string describing the ESSBASEPATH environment variable |
Notes
Call EssSetPath() before calling EssInit().
pszPath cannot exceed 120 characters, as defined in ESS_PATHLEN.
pszPath applies only to the current process.
Essbase DLLs must be accessible from the system path. EssSetPath() does not resolve the path for the Essbase DLLs.
Return Value
If successful, returns ESS_STS_NOERR.
If pszPath is too long, returns API_NAME_TOO_LONG (1030009).
Example
ESS_STS_T ESS_SetPath() { ESS_STS_T sts; ESS_STR_T pszPath = "C:\Hyperion\products\Essbase"; sts = EssSetPath (pszPath); return sts; }