Fonction CryptXmlAddObject (cryptxml.h)

  • Article

La fonction CryptXmlAddObject ajoute l’élément Object à la signature dans le contexte de document ouvert pour l’encodage.

Syntaxe

HRESULT CryptXmlAddObject(
  [in]            HCRYPTXML                hSignatureOrObject,
                  DWORD                    dwFlags,
  [in, optional]  const CRYPT_XML_PROPERTY *rgProperty,
  [in]            ULONG                    cProperty,
  [in]            const CRYPT_XML_BLOB     *pEncoded,
  [out, optional] const CRYPT_XML_OBJECT   **ppObject
);

Paramètres

[in] hSignatureOrObject

Handle d’une signature retournée par la fonction CryptXmlOpenToEncode ou handle d’une référence retournée par la fonction CryptXmlCreateReference avec l’indicateur CRYPT_XML_FLAG_CREATE_REFERENCE_AS_OBJECT défini.

dwFlags

Spécifie les indicateurs qui contrôlent la façon dont l’objet est ajouté.

Les valeurs dwFlags actuellement définies sont indiquées dans le tableau suivant.

Valeur Signification
CRYPT_XML_ADD_OBJECT_CREATE_REFERENCE
 Lorsqu’elle est définie, une copie en mémoire de la partie XML est créée et incluse dans l’élément Object .

[in, optional] rgProperty

Pointeur vers une structure CRYPT_XML_PROPERTY qui spécifie des propriétés supplémentaires utilisées pour décoder l’élément Object .

[in] cProperty

Nombre d’éléments dans le tableau pointé vers la propriété rgProperty .

[in] pEncoded

Pointeur vers une structure CRYPT_XML_BLOB qui contient l’élément Object .

[out, optional] ppObject

Pointeur vers un pointeur vers une structure CRYPT_XML_OBJECT recevoir la structure décodée. Ce paramètre doit avoir la valeur NULL lorsque le paramètre hSignatureOrObject contient un handle pour l’objet.

Valeur retournée

Si la fonction réussit, la fonction retourne zéro.

Si la fonction échoue, elle retourne une valeur HRESULT qui indique l’erreur.

Remarques

Lorsque le paramètre hSignatureOrObject spécifie un handle à une référence retourné par la fonction CryptXmlCreateReference , le paramètre pEncoded spécifie le contenu XML inclus dans le nœud Object après l’élément Manifest facultatif. Le pointeur contenu dans le paramètre pEncoded doit être valide jusqu’à ce que la signature soit terminée. Sinon, utilisez l’indicateur CRYPT_XML_FLAG_ADD_OBJECT_CREATE_COPY pour créer une copie en mémoire.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête cryptxml.h
Bibliothèque Cryptxml.lib
DLL Cryptxml.dll