EAP_CONFIG_INPUT_FIELD_DATA (Compact 2013)

3/26/2014

This structure contains the data associated with a single input field.

Syntax

typedef struct _EAP_CONFIG_INPUT_FIELD_DATA {
  DWORD dwSize;
  EAP_CONFIG_INPUT_FIELD_TYPE Type;
  DWORD dwFlagProps;
  LPWSTR pwszLabel;
  LPWSTR pwszData;
  DWORD dwMinDataLength;
  DWORD dwMaxDataLength;
} EAP_CONFIG_INPUT_FIELD_DATA,
  *PEAP_CONFIG_INPUT_FIELD_DATA;

Members

• dwSize
  The size, in bytes, of the EAP_CONFIG_INPUT_FIELD_DATA structure. This field is used for versioning purposes.

• Type
  An EAP_CONFIG_INPUT_FIELD_TYPE enumeration value that specifies the type of the input field.

• dwFlagProps
  A set of flag values that describe properties of the EAP configuration input field.

  Value	Meaning
  EAP_UI_INPUT_FIELD_PROPS_DEFAULT 0X00000000	Represents the default property value for input field entries displayed in the UI.
  EAP_CONFIG_INPUT_FIELD_PROPS_DEFAULT 0X00000000	Represents the default property value for configuration input field entries displayed in the UI.
  EAP_UI_INPUT_FIELD_PROPS_NON_DISPLAYABLE 0X00000001	Specifies that input field entries will not be displayed in the UI (a password or Personal Identification Number (PIN), for example).
  EAP_CONFIG_INPUT_FIELD_PROPS_NON_DISPLAYABLE 0X00000001	Specifies that configuration input field entries will not be displayed in the UI (a password or Personal Identification Number (PIN), for example).
  EAP_CONFIG_INPUT_FIELD_PROPS_NON_PERSIST 0X00000002	Indicates that the EAP method will not cache the field data; the supplicant must cache the field data for roaming.
  EAP_UI_INPUT_FIELD_PROPS_READ_ONLY 0x00000004	Indicates that the input field is read-only and cannot be edited.

• pwszLabel
  A pointer to a zero-terminated Unicode string that contains the label for the input field. The caller must free the inner pointers that use the function EapHostPeerFreeMemory, starting at the innermost pointer.

  Value	Meaning
  MAX_EAP_CONFIG_INPUT_FIELD_LENGTH 256	Specifies the maximum supported length of an input field.

• pwszData
  A pointer to a zero-terminated Unicode string that contains the data that was entered by the user into the input field. This value is initially empty. It is populated in a Single-Sign-On (SSO) scenario and returned to EAPHost with a call to EapHostPeerQueryUserBlobFromCredentialInputFields. The caller must free the inner pointers by using the function EapHostPeerFreeMemory, starting at the innermost pointer.

  Value	Meaning
  MAX_EAP_CONFIG_INPUT_FIELD_VALUE_LENGTH 1024	Specifies the maximum supported length of an input field.

• dwMinDataLength
  The minimum length, in bytes, allowed for data that is entered by the user into the EAP configuration dialog box input field.

• dwMaxDataLength
  The maximum length, in bytes, allowed for data that is entered by the user into the EAP configuration dialog box input field.

Remarks

The EAP_CONFIG_INPUT_FIELD_DATA structure can be employed to support SSO.

This structure represents the data associated with a single input field in an EAP configuration dialog box. For example, it could contain the data for the "Login User" as supplied by the EAP application user.

The entire collection of input fields in a EAP configuration dialog box is represented by a EAP_CONFIG_INPUT_FIELD_ARRAY structure.

See Also

Reference

Common EAPHost Structures
EAP_CONFIG_INPUT_FIELD_ARRAY
EapPeerQueryCredentialInputFields