Previous Topic: Sm_PolicyApi_GetWSFEDScheme()Next Topic: Sm_PolicyApi_InitEx()

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

Sm_PolicyApi_Init()

Initializes the connection to the SiteMinder policy store and establishes the init handle.

You can specify an initialization flag that will affect the API's behavior.

This function must be called once per API client session. It must be the first function called in the session.

Type

Required function.

Syntax

int SM_EXTERN Sm_PolicyApi_Init (
   void**                           ppInitHandle,
   const Sm_PolicyApi_InitFlags_t   nInitFlag
);

Parameter

I/O

Description

ppInitHandle

O

A pointer to an internal Policy Management API data structure that contains client session information. This init handle is returned on successful initialization and is used as an input parameter to every call to Sm_PolicyApi_Login() and Sm_PolicyApi_Release().

nInitFlag

I

Value affecting the behavior of the API.

Returns