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

Sm_PolicyApi_GetWSFEDScheme()

Gets an existing WSFED authentication scheme object.

Syntax

int SM_EXTERN Sm_PolicyApi_GetWSFEDScheme (
        void* pSessionHandle,
        const char * pszProviderOid,
        Sm_PolicyApi_Scheme_t** ppstructScheme,
        Sm_PolicyApi_WSFEDProviderProp_t** ppProps
);

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 WSFED auth scheme.

ppstructScheme

[out] The address of the pointer to SiteMinder auth scheme structure.

ppProps

[out] The address of the pointer to linked list WSFED provider properties.

Return Values

• Sm_PolicyApi_Success. The authentication scheme was retrieved successfully.
• Sm_PolicyApi_Failure. The authentication scheme 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 provider OID was not found.