Returns the list of login instances in the current session.
Syntax
ESS_FUNC_M EssListLogins (hCtx, count, logins);
| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
count | ESS_PUSHORT_T | Pointer to the number of logins returned from the server. |
logins | ESS_PPCONNECTINFO_T | Pointer to an array of a ESS_CONNECTINFO_T structure containing connection information. |
Notes
You can call EssListLogins() more than once for the same user name and server. The API returns a unique context handle for each login to the server.
Return Value
If successful, returns login information and a count of current logins.
Access
Before calling this function, you must first initialize the API and obtain a valid instance handle by calling EssInit().
See Also