Previous Topic: SmDirSetUserDisabledState()Next Topic: SmDirValidateUserDN()

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

SmDirValidateInstance()

SiteMinder calls SmDirValidateInstance() so that the Directory API can validate the instance for which the handle is passed.

Either the directory instance handle or user instance handle can be passed through pInstanceHandle. Your code must determine which handle is passed. Check to see if the handle is valid and return the corresponding response.

Syntax

int SM_EXTERN SmDirValidateInstance (
   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 instance handle or directory instance handle.

Returns

Returns 0 if successful or -1 if not successful.