EapHostPeerCredentialsXml2Blob function

Generates the credentials BLOB. The credentials BLOB contains only user data such as user name, password, and PIN. A configuration BLOB, in contrast, contains the settings that control the behavior of the method.

Syntax


DWORD WINAPI EapHostPeerCredentialsXml2Blob(
  _In_  DWORD           dwFlags,
  _In_  IXMLDOMNode     *pCredentialsDoc,
  _In_  DWORD           dwSizeOfConfigIn,
  _In_  BYTE            *pConfigIn,
  _Out_ DWORD           *pdwSizeofCredentialsOut,
  _Out_ BYTE            **ppCredentialsOut,
  _Out_ EAP_METHOD_TYPE *pEapMethodType,
  _Out_ EAP_ERROR       **ppEapError
);

Parameters

dwFlags [in]

Not used. Set to 0.

pCredentialsDoc [in]

A pointer to an XML node of a document that contains credentials which are either user or machine credentials depending on the configuration passed in. The XML document is created with the EapHostUserCredentials Schema.

dwSizeOfConfigIn [in]

The size, in bytes, of the buffer pointed to by the pConfigIn parameter.

pConfigIn [in]

A pointer to a byte buffer that contains a configuration BLOB for which the credentials are configured. The buffer is of size dwSizeofConfigIn.

pdwSizeofCredentialsOut [out]

The size, in bytes, of the buffer pointed to by ppCredentialsOut.

ppCredentialsOut [out]

A pointer to a pointer to a byte buffer that receives the credentials BLOB buffer generated by the input XML. The buffer can is of size pdwSizeofCredentialsOut. After consuming the data, this memory must be freed by calling EapHostPeerFreeMemory.

pEapMethodType [out]

A pointer to an EAP_METHOD_TYPE structure referred to in the XML document.

ppEapError [out]

A pointer to a pointer to an EAP_ERROR structure that contains any errors raised by EAPHost during the execution of this function call. After consuming the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.

Remarks

The configuration BLOB is originally returned by one of the following methods.

The XML based credentials can come from group policy or from a system administrator.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eaphostpeerconfigapis.h

Library

Eappcfg.lib

DLL

Eappcfg.dll

See also

EAPHost Supplicant Configuration Functions
EapHostPeerConfigXml2Blob
EapHostPeerInvokeConfigUI
EapHostPeerGetResult

 

 

Community Additions

ADD
Show: