Writes the existing outline information to disk, specifying whether to save in UTF-8 encoding or in non-Unicode encoding..
Syntax
ESS_FUNC_M EssOtlWriteOutlineEx(hOutline, pObject, iOtlType);
Parameter | Data Type | Description |
---|---|---|
hOutline | ESS_HOUTLINE_T | Outline context handle. |
pObject | ESS_POBJDEF_T | Outline object to write. |
iOtlType | Whether the outline is saved in Unicode mode or non-Unicode mode. The valid values are:
|
Notes
If you are saving the outline as a server object, the outline is initially saved as a .OTN file. You should then call EssOtlRestructure() to create the actual .OTL file.
If you are saving the outline as a server object, the object name must be the same as the database name.
The database must already exist if you are saving a server outline object, or a client outline object to a local database.
This call fails if the outline is not currently locked by the specified user (hCtx parameter in the ESS_OBJDEF_T structure).
Return Value
Returns 0 if successful; otherwise one of the following:
OTLAPI_BAD_OBJTYPE
OTLAPI_ERR_NOTVERIFIED
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 write the outline object, 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