Méthode IWSDDeviceHost ::SetMetadata (wsdhost.h)

Article
03/04/2024

Définit les métadonnées d’un appareil, à l’exclusion des métadonnées de service définies par l’utilisateur.

Syntaxe

HRESULT SetMetadata(
  [in]           const WSD_THIS_MODEL_METADATA   *pThisModelMetadata,
  [in]           const WSD_THIS_DEVICE_METADATA  *pThisDeviceMetadata,
  [in, optional] const WSD_HOST_METADATA         *pHostMetadata,
  [in, optional] const WSD_METADATA_SECTION_LIST *pCustomMetadata
);

Paramètres

[in] pThisModelMetadata

Référence à une structure WSD_THIS_MODEL_METADATA qui spécifie les métadonnées communes à toutes les instances du modèle de cet appareil. Les membres Manufacturer, ModelNames et ModelNumber de la structure doivent contenir des entrées non NULL et non vides.

[in] pThisDeviceMetadata

Référence à une structure WSD_THIS_DEVICE_METADATA qui spécifie des métadonnées propres à cet appareil. Les membres FriendlyName, FirmwareVersion et SerialNumber de cette structure doivent contenir des entrées non NULL et non vides.

[in, optional] pHostMetadata

Référence à une structure de WSD_HOST_METADATA qui spécifie les métadonnées de l’hôte de service, dont les données et caractéristiques spécifiques de l’appareil (par exemple, une imprimante prend en charge la couleur ou a une agrafeuse).

[in, optional] pCustomMetadata

Référence à une structure de WSD_METADATA_SECTION_LIST qui spécifie des métadonnées personnalisées supplémentaires associées à cet appareil.

Valeur retournée

Les valeurs de retour possibles incluent, sans s’y limiter, les éléments suivants :

Code de retour	Description
S_OK	La méthode s’est terminée avec succès.
E_INVALIDARG	pThisDeviceMetadata a la valeur NULL, pThisModelMetadata a la valeur NULL, ou l’une ou l’autre structure ne contient pas les membres requis. Consultez les descriptions des paramètres pour obtenir la liste des membres requis.
E_OUTOFMEMORY	Mémoire insuffisante pour terminer l’opération.

Remarques

Cette méthode doit être appelée au moins une fois avant de démarrer tout hôte d’appareil inscrit auprès de RegisterService. Il peut être appelé après le démarrage de l’appareil pour mettre à jour les métadonnées, auquel cas WS-Discovery messages Hello sont émis indiquant la nouvelle version des métadonnées.

Note La fonctionnalité de mise à jour n’a pas encore été implémentée.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	wsdhost.h (inclure Wsdapi.h)
DLL	Wsdapi.dll

Voir aussi

IWSDDeviceHost