CryptXmlDllEncodeKeyValue callback function (cryptxml.h)

The CryptXmlDllEncodeKeyValue function encodes a KeyValue element.

Syntax

CryptXmlDllEncodeKeyValue Cryptxmldllencodekeyvalue;

HRESULT Cryptxmldllencodekeyvalue(
  [in]      NCRYPT_KEY_HANDLE hKey,
            CRYPT_XML_CHARSET dwCharset,
  [in, out] void *pvCallbackState,
  [in]      PFN_CRYPT_XML_WRITE_CALLBACK pfnWrite
)
{...}

Parameters

[in] hKey

The handle of the key value to encode.

dwCharset

A value of the CRYPT_XML_CHARSET enumeration that specifies the character set of the encoded XML.

[in, out] pvCallbackState

A pointer to an argument that is passed to the callback function pointed to by the pfnWrite parameter.

[in] pfnWrite

An application defined callback function that receives the encoded XML.

Return value

If the function succeeds, the function returns zero.

If the function fails, it returns an HRESULT value that indicates the error.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header cryptxml.h