SmDirReleaseInstance()

Programming Guides › Programming Guide for C › Directory API › Sequence of Function Calls › SmDirReleaseInstance()

SmDirReleaseInstance()

The SiteMinder Policy Server calls SmDirReleaseInstance() so that you can release the user instance or the directory instance if you choose.

Syntax

void SM_EXTERN SmDirReleaseInstance (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle
);

Parameter	I/O	Description
lpApiContext	I	Pointer to the API context structure.
pHandle	I	The address of the pointer returned by SmDirInit().
pInstanceHandle	I	The address of a pointer to the user or directory instance handle. To release the user instance, ensure that pInstanceHandle contains the user instance handle. To release the directory instance, ensure that pInstanceHandle contains the directory instance handle.

Remarks

You need to write your release code so that it will work with the type of instance handle— user or directory—that is passed.

During a process, the SiteMinder Policy Server may first call SmDirInitDirInstance() and then call SmDirInitUserInstance(). If so, the SiteMinder Policy Server calls SmDirReleaseInstance() twice at the end of the process. At the first call, the user instance handle (as pInstanceHandle) is passed so that you can release the user instance. At the second call, the directory instance handle is passed (as pInstanceHandle) so that you can release the directory instance.

Use the value of nTag to distinguish between a user handle and a directory handle, as follows:

With user handles, nTag in structure DirHandle_t is 0.
With directory handles, nTag in structure UserHandle_t is 1.

Email CA about this topic