Opens and reads in an existing outline, identifying the correct locale. This function (or EssOtlNewOutline()) must be called before any operations on the outline can take place.
Syntax
ESS_FUNC_M EssOtlOpenOutlineEx(hCtx, pObject, fLock, fKeepTrans, pLocaleDescription, phOutline);
| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | Essbase Context handle. |
pObject | ESS_POBJDEF_T | Pointer to an object structure defining the outline object to open. |
fLock | ESS_BOOL_T | Flag to determine if the outline should be locked when it is opened. This is valid only for server outlines. |
fKeepTrans | ESS_BOOL_T | Flag to determine whether to keep transactions. If you are opening an existing outline to make changes, and you intend to restructure the database and keep data, we recommend that you set this flag to ESS_TRUE. When ESS_TRUE, a log is kept of activities done to the outline. If you are starting from an empty outline or are not planning on saving data when you restructure, we recommend that you set this field to ESS_FALSE. When ESS_FALSE, no log is kept, saving time and memory. |
pLocaleDescription | The identifier used by GlobalC to identify the Locale. The LocaleDescription is in the form of: [language]_[territory].[codepage]@[sort] For example: Japaness_japan.MS932@binary to provide the locale description of the language of the outline file. It is the program’s responsibility to pass pLocaleDescription in the current format. | |
phOutline | ESS_PHOUTLINE_T | Pointer to an ESS_HOUTLINE_T variable. This handle is set by the API and should be passed to subsequent Outline API functions. |
Notes
This function works like EssOtlOpenOutline(), but with the addition of a Unicode-specific LocaleDescription argument.
If the outline file exists on the server, this call copies the file locally for client access.
For aggregate storage database outlines, EssOtlOpenOutline keeps the outline open until EssOtlCloseOutline is called. Because aggregate storage outlines are paged into memory (instead of being read entirely into memory) the outline is kept open. As a result, temporary files remain in your computer's Temp folder until EssOtlCloseOutline is called.
Return Value
Returns 0 if successful; otherwise one of the following:
OTLAPI_BAD_OBJTYPE
OTLAPI_ERR_FILEOPEN
OTLAPI_ERR_FILEIO
Access
This function requires you to have the appropriate level of access to the specified application and/or database to contain the outline object. To lock the outline object (lock flag is ESS_TRUE), you must have Application Designer or Database Designer privilege (ESS_PRIV_APPDESIGN or ESS_PRIV_DBDESIGN) for the specified application or database containing the outline.
See Also