Previous Topic: Sm_PolicyApi_Oid_tNext Topic: Sm_PolicyApi_PasswordPolicy_t


Sm_PolicyApi_PasswordMsgField_t

Describes a password policy message field. A password policy message field contains information about an error that occurred during a validation attempt for a new password.

A password policy message field is associated with a password policy message identifier. This identifier is returned in the nMsgId parameter of Sm_PolicyApi_GetPasswordMsg().

This structure is returned in the ppStructMsgField parameter of Sm_PolicyApi_GetPasswordMsg().

Syntax

typedef struct Sm_PolicyApi_PasswordMsgField_s
{
   int iStructId;
   Sm_PolicyApi_PasswordMsgFieldId_t nId;
   Sm_PolicyApi_FieldType_t nType;
   char pszMsg[BFSIZE];
   int nValue;
   struct Sm_PolicyApi_PasswordMsgField_s* next;
} Sm_PolicyApi_PasswordMsgField_t;

Field

Description

iStructId

Password policy data structure ID, defined in Sm_PolicyApi_Structs_t.

nId

The password message field identifier. Message field identifiers are enumerated in Sm_PolicyApi_PasswordMsgFieldId_t.

nType

The data type of the message field (integer, string, or none) as enumerated in Sm_PolicyApi_FieldType_t.

The value of nType determines whether pszMsg or nValue is populated.

pszMsg

Text that provides information about the error.

nValue

Integer that provides information about the error.

next

Pointer to the next password message field structure.