Sm_PolicyApi_GetUserDirSearchOrder()

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_GetUserDirSearchOrder()

Sm_PolicyApi_GetUserDirSearchOrder()

Retrieves the OIDs of the user directory objects that are associated with the domain identified by pszDomainOid.

The retrieved list of OIDs is stored in the pszArray string array in the order in that they are searched by SiteMinder. Free the memory allocated for this structure by calling Sm_PolicyApi_FreeStringArray().

Type

User directory function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetUserDirSearchOrder (
   void*         pSessionHandle,
   const char*   pszDomainOid,
   char**        pszArray[]
);

Parameter	I/O	Description
pSessionHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszDomainOid	I	A null-terminated string containing the object identifier of an existing domain.
pszArray	O	The returned array of user directory OIDs of the requested objects.

Returns

Sm_PolicyApi_Success. The function successfully returned the user directory search order.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get user directory search order in a domain.
Sm_PolicyApi_InvalidOid. The domain OID was not found.