Previous Topic: SmDirGetDirConnection()Next Topic: SmDirGetGroupMembers()

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

SmDirGetDirObjInfo()

The SiteMinder Policy Server calls SmDirGetDirObjInfo() to get information about the object specified in the lpszObject buffer. You can use this function to get the following information about the object passed in as lpszObject:

The SiteMinder Policy Server calls SmDirFreeString() to free the lpszDN and lpszClass buffers.

Syntax

int SM_EXTERN SmDirGetDirObjInfo (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   const char*              lpszObject,
   char**                   lpszDN,
   char**                   lpszClass,
   int*                     pnSmPolicyResolution
);

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.

lpszObject

I

The string containing the null-terminated string of the user name.

lpszDN

O

Fill in the user distinguished name resolved from the lpszObject.

lpszClass

O

Fill in the class of the resolved user distinguished name.

pnSmPolicyResolution

O

Fill in the Policy resolution of the resolved user distinguished name. Policy resolutions are enumerated in Sm_PolicyResolution_t.

Returns

Returns 0 if successful or -1 if not successful.

Remarks

This function is called in the following circumstances:

Sample Code Information

If you are disabling user account Mikel, Mikel is passed in as lpszObject. Using the sample code, the following values are returned:

Parameter

Value

lpszDN

Mikel

lpszClass

User

pnSmPolicyResolution

1