Sm_PolicyApi_SetAffiliateDomainUserDirSearchOrder()

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

Sm_PolicyApi_SetAffiliateDomainUserDirSearchOrder()

Sets the user directory search order for an affiliate domain.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_SetAffiliateDomainUserDirSearchOrder (
   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	I	An array of user directory OIDs, in the desired order.

Returns

Sm_PolicyApi_Success. The function successfully set 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 set user directory search order in an affiliate domain.
Sm_PolicyApi_InvalidOID. The affiliate OID was not found.
Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain.
Sm_PolicyApi_WrongNumberOfElements. The number of user directories in the affiliate domain collection is different from the number of elements in the array.