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

Sm_PolicyApi_GetUsersFromWSFEDResourcePartner()

Gets the user directory entries associated with a WS-Federation Resource Partner.

Syntax

int SM_EXTERN Sm_PolicyApi_GetUsersFromWSFEDResourcePartner (
        void* pSessionHandle,
        const char * pszProviderOid,
        const char * pszUserPolicyOid,
       Sm_PolicyApi_User_t ** ppStructUsers
);

Parameters

pSessionHandle

[in] A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.

pszProviderOid

[in] A null-terminated string containing the object identifier of an existing WS-Federation Resource Partner.

pszUserPolicyOid

[in] A null-terminated string containing the object identifier of an existing policy user.

ppStructUsers

[out] The address of a pointer to a linked list of user structures.

Return Values

• Sm_PolicyApi_Success. The user directory was added successfully.
• Sm_PolicyApi_Failure. The user directory was not added 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 was not found.