Sm_PolicyApi_GetRegularExpressions()

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

Sm_PolicyApi_GetRegularExpressions()

Gets a list of regular expressions belonging to the referenced password policy. Implemented only if the session's version is set to SM_POLICY_API_VERSION_6_0.

Type

Regular Expression function.

Syntax

int SM_EXTERN    Sm_PolicyApi_GetRegularExpressions (
   void*                               pSessionHandle,
   const char*                         pszPasswordPolicyOid,
   Sm_PolicyApi_RegularExpression_t**  ppstructRegExpr
);

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 PolicyOid	I	The OID of the password policy.
ppstructRegExpr	O	Pointer to a linked list of regular expressions belonging to the referenced password policy.

Returns

Sm_PolicyApi_Success. The regular expression list was retrieved successfully.
Sm_PolicyApi_Failure. The regular expression list was not retrieved successfully.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to get regular expressions.
Sm_PolicyApi_InvalidOid: The password policy OID was not found.

Email CA about this topic