IDXCoreAdapter::GetProperty, méthode

Article
09/21/2022
2 minutes de lecture

Récupère la valeur de la propriété d’adaptateur spécifiée. Avant d’appeler GetProperty pour un type de propriété, appelez IsPropertySupported pour confirmer que le type de propriété est disponible pour cet adaptateur et ce système d’exploitation. Avant d’appeler GetProperty, appelez GetPropertySize pour déterminer la taille nécessaire de la mémoire tampon dans laquelle recevoir la valeur de la propriété.

Syntaxe

virtual HRESULT STDMETHODCALLTYPE GetProperty(
  DXCoreAdapterProperty property,
  size_t bufferSize,
  _Out_writes_bytes_(bufferSize) void *propertyData) = 0;

template <class T>
HRESULT GetProperty( 
  DXCoreAdapterProperty property,
  _Out_writes_bytes_(sizeof(T)) T *propertyData);

Paramètres

propriété

Type : DXCoreAdapterProperty

Type de la propriété dont vous souhaitez récupérer la valeur. Consultez la table dans DXCoreAdapterProperty pour plus d’informations sur chaque propriété d’adaptateur.

bufferSize

Type : size_t

Taille, en octets, de la mémoire tampon de sortie que vous allouez et fournissez dans propertyData.

propertyData [out]

Type : void*

Pointeur vers une mémoire tampon de sortie que vous allouez dans votre application et que la fonction se remplit. Appelez GetPropertySize pour déterminer la taille que la mémoire tampon propertyData doit être pour une propriété d’adaptateur donnée.

Retours

Type : HRESULT

Si la fonction réussit, elle retourne S_OK. Sinon, il retourne un code HRESULTerror.

Valeur retournée	Description
DXGI_ERROR_INVALID_CALL	Le type de propriété spécifié dans la propriété n’est pas reconnu par ce système d’exploitation. Appelez IsPropertySupported pour confirmer que le type de propriété est disponible pour cet adaptateur et ce système d’exploitation.
DXGI_ERROR_UNSUPPORTED	Le type de propriété spécifié dans la propriété n’est pas pris en charge par l’adaptateur. Appelez IsPropertySupported pour confirmer que le type de propriété est disponible pour cet adaptateur et ce système d’exploitation.
E_INVALIDARG	Une taille de mémoire tampon insuffisante est fournie dans propertyData. Appelez GetPropertySize pour déterminer la taille que la mémoire tampon propertyData doit être pour une propriété d’adaptateur donnée.
E_POINTER	`nullptr` a été fourni pour propertyData.

Notes

Vous pouvez appeler GetProperty sur un adaptateur qui n’est plus valide, la fonction ne échouera pas en conséquence. Cette fonction supprime la mémoire tampon propertyData avant de la remplir.

Voir aussi

IDXCoreAdapter, référence DXCore, utilisation de DXCore pour énumérer des adaptateurs