Sm_PolicyApi_GetDirectoryContents()

Programming Guides › Programming Guide for C › Policy Management API › Function Declarations for the Policy Management API › Sm_PolicyApi_GetDirectoryContents()

Sm_PolicyApi_GetDirectoryContents()

Retrieves a linked list of user structures (referenced by ppStructUsers) for a particular user directory.

The granularity of the response to this function is governed by the following registry entry:

HKLM\Software\Netegrity\SiteMinder\CurrentVersion\Ds\ClassFilters

Free the memory allocated for the returned structures by calling Sm_PolicyApi_FreeMemoryEx().

Type

User directory function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetDirectoryContents (
   void*                     pSessionHandle,
   const char*               pszUserDirOid,
   Sm_PolicyApi_User_t**     ppStructUserSpec
);

Parameter	I/O	Description
pSessionHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszUserDirOid	I	A null-terminated string containing the object identifier of an existing user directory.
ppStructUserSpec	O	The address of a pointer to a user structure.

Returns

Sm_PolicyApi_Success. The retrieve operation was successful.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_InvalidOid. The user directory OID was not found.

Email CA about this topic