Previous Topic: Sm_PolicyApi_SetPassword()Next Topic: Sm_PolicyApi_SetResponseInPolicyLink()

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

Sm_PolicyApi_SetPath()

Sets the path of the user identified by pUser in the policy identified by pszPolicyOid.

Type

User and user state function.

Syntax

int SM_EXTERN Sm_PolicyApi_SetPath (
   void*          	pSessionHandle,
   Sm_PolicyApi_User_t* pUser
   const char*    	pszNewPath,
   const char*    	pszPolicyOid
);

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.

pUser

I

A pointer to an Sm_PolicyApi_user_t structure containing information about the user.

pszNewPath

I

New path for the user.

pszPolicyOid

I

A null-terminated string containing the object identifier of an existing policy to which a user path is to be set.

Remarks

This function is successful only when the pointer to Sm_PolicyApi_User_t is obtained with the Sm_PolicyApi_GetPolicyUsers() function. If the user is retrieved with Sm_PolicyApi_LookupDirectoryEntry(), Sm_PolicyApi_GetDirectoryContents(), or Sm_PolicyApi_ValidateDirectoryEntry(), pszUserPolicyOid will be invalid and the call will fail.

Returns