CryptXmlSign function (cryptxml.h)

The CryptXmlSign function creates a cryptographic signature of a SignedInfo element.

Syntax

HRESULT CryptXmlSign(
  [in]           HCRYPTXML                       hSignature,
  [in, optional] HCRYPTPROV_OR_NCRYPT_KEY_HANDLE hKey,
                 DWORD                           dwKeySpec,
                 DWORD                           dwFlags,
                 CRYPT_XML_KEYINFO_SPEC          dwKeyInfoSpec,
  [in, optional] const void                      *pvKeyInfoSpec,
  [in]           const CRYPT_XML_ALGORITHM       *pSignatureMethod,
  [in]           const CRYPT_XML_ALGORITHM       *pCanonicalization
);

Parameters

[in] hSignature

The handle to a CRYPT_XML_SIGNATURE structure.

[in, optional] hKey

The handle of a private key used to sign the SignedInfo element. This parameter must be NULL for HMAC-based signature algorithms.

dwKeySpec

A DWORD value that specifies the key type. This parameter can be one of the following values.

dwFlags

A DWORD value that controls how the data is signed. This parameter can be one of the following values.

dwKeyInfoSpec

The type of data structure pointed to by the pvKeyInfoSpec parameter. Here are some possible combinations.

[in, optional] pvKeyInfoSpec

A pointer to a structure, the type of which is determined by the value of the dwKeyInfoSpec parameter.

[in] pSignatureMethod

A pointer to a CRYPT_XML_ALGORITHM structure that specifies the signature method.

[in] pCanonicalization

A pointer to a CRYPT_XML_ALGORITHM structure that specifies the canonicalization method.

Return value

If the function succeeds, the function returns zero.

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

Remarks

If a certificate cannot be found CryptXmlSign will create a UI for certificate selection. If this window is generated from a process running in session 0, the application may unexpectedly terminate.

Requirements