Sm_PolicyApi_GetPasswordPolicyByName()

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

Sm_PolicyApi_GetPasswordPolicyByName()

Gets the contents of a password policy object.

Type

Password policy function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetPasswordPolicyByName (
   void*                           pSessionHandle,
   const char*                     pszPasswordPolicyName,
   Sm_PolicyApi_PasswordPolicy_t** ppstructPasswordPolicy
);

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.
pszPassword PolicyName	I	A null-terminated string containing the name of the password policy.
ppstruct PasswordPolicy	O	The address of a pointer to Sm_PolicyApi_PasswordPolicy_t.

Returns

Sm_PolicyApi_Success. The get was successful.
Sm_PolicyApi_Failure. Memory could not be allocated to Sm_PolicyApi_PasswordPolicy_t.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get a password policy.
Sm_PolicyApi_NotFound. The password policy name was not found.