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

Sm_PolicyApi_GetWSFEDResourcePartner()

Gets an existing Resource Partner object.

Syntax

int SM_EXTERN Sm_PolicyApi_GetWSFEDResourcePartner (
        void* pSessionHandle,
        const char * pszProviderOid;
        Sm_PolicyApi_WSFEDResourcePartner_t** pstructServiceProvider
);

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.

pstructServiceProvider

[out] The address of the pointer to WS-Federation Resource Partner structure.

Return Values

• Sm_PolicyApi_Success. The Resource Partner was retrieved successfully.
• Sm_PolicyApi_Failure. The Resource Partner 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 an affiliate.
• Sm_PolicyApi_InvalidOID. The Resource Partner OID was not found.
• Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain