Previous Topic: SmDirValidateInstance()Next Topic: SmDirValidateUsername()

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

SmDirValidateUserDN()

Use this function to perform any needed validation on the user ID passed in through lpszUserDN.

If you do not need to implement SmDirValidateUserDN(), return 0, as shown in the sample code.

Syntax

int SM_EXTERN SmDirValidateUserDN (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   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().

pInstanceHandle

I

The address of a pointer to the directory instance handle.

lpszUserDN

I

Buffer containing the user DN that has to be validated.

Returns

Returns 0 if successful or -1 if not successful.

Remarks

This function is called when you use the SiteMinder Test Tool to run IsAuthenticated for a user in the custom directory.