Gets the cookie associated with the current session, if a cookie was created at initialization. For more information, see the custom callback function, CookieCreateFunc, available with ESS_INIT_T.
Syntax
ESS_FUNC_M EssGetCookie (ESS_HCTX_T, ESS_PPVOID_T);
| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
ppCookie | ESS_PPVOID_T | Address of a pointer to receive cookie. |
Return Value
If successful, returns the cookie created at initialization.
Access
This function requires no special privileges.
Example
See the query cancellation example in the topic for ESS_INIT_T.