# EssGSetPath

Description

EssGSetPath() sets the ARBORPATH environment variable for the current process.

Syntax

    ESSG_FUNC_M EssGSetPath (pszPath);

ESSG_STR_T | pszPath;

Parameters

pszPath | Pointer to the string describing the ARBORPATH environment variable

Return Value

- If successful, returns ESSG_STS_NOERR.
- If pszPath is too long, returns API_NAME_TOO_LONG (1030009).

Notes

- Call EssGSetPath() before calling EssGInit().
- pszPath cannot exceed 120 characters, as defined in ESSG_PATHLEN.
- pszPath applies only to the current process.
- Hyperion (Arbor) DLLs must be accessible from the system path. EssGSetPath() does not resolve the path for the Hyperion (Arbor) DLLs.

Example

    ESS_STS_T
    ESSG_SetPath(ESS_STR_T pszPath)
    {
       ESS_STS_T  sts
       ESSG_STR_T pszPath = "C:\Essbase";
       sts = EssGSetPath (pszPath);
       return sts;
    }

See Also

Using the Grid API Functions
Grid API Structures