Previous Topic: SmDirGetRoleMembers()Next Topic: SmDirGetUserAttrMulti()

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

SmDirGetUserAttr()

The SiteMinder Policy Server calls SmDirGetUserAttr() so that you can retrieve the value for a user attribute in your custom directory. For example, you may need to retrieve the last name of a user.

SiteMinder calls SmDirFreeString() to free the lpszAttrData buffer.

Syntax

int SM_EXTERN SmDirGetUserAttr (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   const char*              lpszUserDN,
   const char*              lpszAttrName,
   char**                   lpszAttrData
);

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 whose user attribute has to be retrieved.

lpszAttrName

I

Buffer containing the name of the user attribute whose value you’re retrieving.

lpszAttrData

O

Buffer containing the retrieved value for the requested attribute. Look up the value of the attribute specified in lpszAttrName and return the value in lpszAttrData.

Returns

Returns 0 if successful or -1 if not successful.