CryptXmlOpenToEncode function
If CryptXmlOpenToEncode function opens an XML digital signature to encode and returns a handle of the opened Signature element. The handle encapsulates a document context with a single CRYPT_XML_SIGNATURE structure and remains open until the CryptXmlClose function is called.
Syntax
HRESULT WINAPI CryptXmlOpenToEncode( _In_opt_ CRYPT_XML_TRANSFORM_CHAIN_CONFIG *pConfig, DWORD dwFlags, _In_opt_ LPCWSTR wszId, _In_ CRYPT_XML_PROPERTY *rgProperty, _In_ ULONG cProperty, _In_opt_ CRYPT_XML_BLOB *pEncoded, HCRYPTXML *phSignature );
Parameters
- pConfig [in, optional]
-
The handle of the transform chain engine. If this parameter is NULL, then a default engine is used to apply transforms.
- dwFlags
-
A DWORD value that controls which CryptXML extensions are loaded and whether the XML is serialized. This parameter can be one of the following values.
- wszId [in, optional]
-
A pointer to a null-terminated Unicode string that contains the Id attribute of the Signature element. If this parameter is NULL, then a new GUID is generated. If this parameter is an empty string, then no Id attribute is produced.
- rgProperty [in]
-
A pointer to an array of CRYPT_XML_PROPERTY structures that specify additional properties.
- cProperty [in]
-
The number of elements in the array pointed to by the rgProperty parameter.
- pEncoded [in, optional]
-
A pointer to a CRYPT_XML_BLOB structure that contains the signature to encode.
- phSignature [optional]
-
The handle to the Signature element.
Return value
If the function succeeds, the function returns zero.
If the function fails, it returns an HRESULT value that indicates the error.
Requirements
|
Minimum supported client |
Windows 7 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|