Lists users who are externally authenticated through Shared Services.
Syntax
ESS_FUNC_M EssListExtUsers (hCtx, AppName, DbName, Protocol, Count, ppUserList);| Parameter | Data Type | Description |
|---|---|---|
hCtx | ESS_HCTX_T | API context handle. |
AppName | ESS_STR_T | Application name. If NULL, lists all users. |
DbName | ESS_STR_T | Database name. If NULL, lists users for all databases within application. |
Protocol | ESS_STR_T | External authentication protocol: CSS, for Shared Services mode. Even if the protocol is not specified, this function returns a list of users who are externally authenticated through Shared Services. |
Count | ESS_PUSHORT_T | Address of variable to receive count of users. |
ppUserList | ESS_USERINFOEX_T | Address of pointer to receive an allocated array of user info structures. The AppName and DbName fields of the returned user info structures contain NULL values. |
Notes
If both AppName and DbName are not NULL, only users with access to the specified application and database are listed. If DbName is NULL, only users with access to the specified application are listed. If AppName is NULL, all users that exist on the server are listed.
The AppName and DbName fields of the returned ESS_USsERINFO_T structures contain NULL values.
The memory allocated for ppUserList should be freed using EssFree().
Return Value
If successful, returns a count of the number of users in pCount, and list of users with access to the specified application and database in ppUserList.
Access
This function requires no special privileges.
See Also