Sends an update specification to the active aggregate storage database from a UTF-8-encoded file.
Syntax
ESS_FUNC_M EssUpdateFileUTF8ASO (hDestCtx, hSrcCtx, AppName, DbName, FileName, Store, Unlock, ulBufferId);
| Parameter | Data Type | Description |
|---|---|---|
hDestCtx | ESS_HCTX_T | API context handle of target database on the server |
hSrcCtx | ESS_HCTX_T | API context handle for update file location. The update file can reside on the client or on the same server as the target database. |
AppName | ESS_STR_T | Application name for update file location |
DbName | ESS_STR_T | Database name for update file location |
FileName | ESS_STR_T | Name of update specification file |
Store | ESS_BOOL_T | Controls storage of data. If TRUE, data is stored in the server; if FALSE, no data is stored. |
Unlock | ESS_BOOL_T | Not supported for aggregate storage databases. You must always pass ESS_FALSE for this parameter. |
ulBufferId | ESS_ULONG_T | ID number for the data load buffer. |
Notes
If the Store flag is set to FALSE, the database merely performs a syntax check of the update specification.
Return Value
Returns zero if successful; otherwise, returns an error code and the records that caused the error.
Access
This function requires the caller to have write privilege (ESS_PRIV_WRITE) to the active database.
Example
See example for EssUpdateFileAso.
See Also