SmDirInitUserInstance()

Programming Guides › Programming Guide for C › Directory API Guidance › Directory API Reference › SmDirInitUserInstance()

SmDirInitUserInstance()

The SiteMinder Policy Server calls SmDirInitUserInstance() before it calls any of the directory entry (user) operations functions on the given directory instance.

SmDirInitUserInstance() can be called multiple times.

Syntax

int SM_EXTERN SmDirInitUserInstance (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void**                   ppInstanceHandle,
   void*                    pDirInstanceHandle,
   const char*              lpszUserDN
);

Parameter	I/O	Description
lpApiContext	I	Pointer to the API context structure.
pHandle	I	The address of the pointer returned by SmDirInit().
ppInstanceHandle	O	The address of a pointer to hold the handle for the user instance session.
pDirInstanceHandle	I	The address of a pointer handle for the directory instance session. This value is passed in from SmDirInitDirInstance().
lpszUserDN	I	The string containing the null-terminated string of the user distinguished name.

Returns

Returns 0 if successful or -1 if not successful.

Remarks

Instantiate UserHandle_t when SmDirInitUserInstance() is called. Set nTag to 1 to distinguish the user instance handle from the directory instance handle.

The handle referenced by UserHandle_t is passed to subsequent directory entry (user) operations functions. You can change the handle value.

After SiteMinder completes the calls to the relevant directory entry (user) operations functions, it calls SmDirReleaseInstance(). Release UserHandle_t when this call is made. Use the value of nTag to distinguish between the user instance handle and the directory instance handle.