SmDirGetUserProperties()

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

SmDirGetUserProperties()

SiteMinder calls SmDirGetUserProperties() so that you can return the names of all user attributes or only required user attributes.

Unlike SmDirGetUserAttr(), which is designed to return values for the attribute names passed, SmDirGetUserProperties() is designed for returning only attribute names.

SiteMinder calls SmDirFreeStringArray() to free the lpszProperties array.

Syntax

int SM_EXTERN SmDirGetUserProperties (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   const char*              lpszUserDN,
   const int                bMandatory,
   char***                  lpszProperties
);

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.
lpszUserDN	I	Buffer containing the user DN for which you must retrieve the names of user attributes.
bMandatory	I	A value specifying whether to return only mandatory attribute names. The value 1 indicates that only mandatory attribute names are returned; 0 indicates that all attribute names are returned. Some directories have interfaces that distinguish between the mandatory attributes of an object and the optional attributes. For example, IADs for Microsoft Active Directory makes this distinction.
pszProperties	O	Array containing a list of user attribute names.

Returns

Returns 0 if successful or -1 if not successful.

Email CA about this topic