# EssListLogins

Description

EssListLogins() returns the list of login instances in the current session.

Syntax

    ESS_FUNC_M EssListLogins (hCtx, count, logins);

ESS_HCTX_T | hCtx
ESS_SPUSHORT_T | count
ESS_PPLOGININFO_T | logins

Parameters

hCtx | Essbase API context handle.
count | Pointer to the number of logins in the login list returned from the server.
logins | Pointer to an array of a ESS_LOGININFO_T structures which contain login information.

Return Value

If successful, returns login information and a count of current logins.

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 specified server.

Access

Before calling this function, you must first initialize the API and obtain a valid instance handle by calling EssInit().

Example

See Also

EssAutoLogin()
EssInit()
EssListDatabases
EssLogout()
EssSetActive()