Sm_PolicyApi_GetAffiliateDomainUserDirSearchOrder()

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

Sm_PolicyApi_GetAffiliateDomainUserDirSearchOrder()

Gets the user directory search order for an affiliate domain.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAffiliateDomainUserDirSearchOrder (
   void*        pSessionHandle,
   const char*  pszAffiliateDomainOid,
   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.
pszAffiliate DomainOid	I	A null-terminated string containing the object identifier of an existing affiliate 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_Failure. The function did not successfully return the user directory search order.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get user directory search order in an affiliate domain.
Sm_PolicyApi_InvalidOID. The affiliate domain OID was not found.