Previous Topic: Sm_PolicyApi_GetAffiliate()Next Topic: Sm_PolicyApi_GetAffiliateDomain()

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

Sm_PolicyApi_GetAffiliateByName()

Gets an affiliate.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAffiliateByName (
   void*                       pSessionHandle,
   const char*                 pszAffiliateOid,
   const char*                 pszAffiliateName,
   Sm_PolicyApi_Affiliate_t**  ppstructAffiliate
);

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.

pszAffiliateName

I

A null-terminated string containing the name of an existing affiliate.

ppstruct
  Affiliate

O

The address of a pointer to an affiliate structure.

Remarks

This function retrieves affiliate objects that are based on the artifact profile or the POST profile (see the Sm_PolicyApi_Affiliate_t field SAMLProfile). Retrieval of an affiliate object based on the POST profile requires an API version of at least SM_POLICY_API_VERSION_6_0_2. If an earlier version is involved, and the function specifies an affiliate object based on a POST profile, the request fails.

Returns