Sm_PolicyApi_GetAffiliateUsers()

Gets the user directory entries for an affiliate.
casso10
Gets the user directory entries for an affiliate.
Type
Federation function
Syntax
int SM_EXTERN Sm_PolicyApi_GetAffiliateUsers (
void*pSessionHandle,
const char*pszAffiliateOid,
const char*pszUserDirOid,
Sm_PolicyApi_User_t**ppStructUsers
);
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.
pszAffiliateOid
I
A null-terminated string containing the object identifier of an existing affiliate.
pszUserDirOid
I
A null-terminated string containing the object identifier of an existing user directory.
ppStructUsers
O
The address of a pointer to a linked list of user structures.
Returns
  • Sm_PolicyApi_Success. The user was retrieved successfully.
  • Sm_PolicyApi_Failure. The user was not retrieved successfully.
  • 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 retrieve users.
  • Sm_PolicyApi_InvalidOID. The affiliate OID or user directory OID was not found.