Previous Topic: SmDirChangeUserPassword()Next Topic: SmDirFreeString()

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

SmDirEnumerate()

The SiteMinder Policy Server calls SmDirEnumerate() to retrieve a list of distinguished names and their corresponding class names (User or Group) in the user directory.

The SiteMinder Policy Server calls SmDirFreeStringArray() to free the lpszDNs and lpszClasses arrays.

Syntax

int SM_EXTERN SmDirEnumerate (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   char***                  lpszDNs,
   char***                  lpszClasses
);

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.

lpszDNs

O

List of user distinguished names present in the directory.

lpszClasses

O

List of corresponding class information for the user distinguished names.

Returns

Returns 0 if successful or -1 if not successful.

Remarks

This function is called when you click the View Contents button in the SiteMinder User Directory Dialog box.