WdfUsbTargetDeviceRetrieveCurrentFrameNumber, fonction (wdfusb.h)

Article
02/07/2025

[S’applique uniquement à KMDF]

La méthode WdfUsbTargetDeviceRetrieveCurrentFrameNumber récupère le numéro d’image USB actuel.

Syntaxe

NTSTATUS WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
  [in]  WDFUSBDEVICE UsbDevice,
  [out] PULONG       CurrentFrameNumber
);

Paramètres

[in] UsbDevice

Handle vers un objet de périphérique USB obtenu à partir d’un appel précédent à WdfUsbTargetDeviceCreateWithParameters.

[out] CurrentFrameNumber

Pointeur vers un emplacement qui reçoit le numéro d’image USB 32 bits actuel.

Valeur de retour

WdfUsbTargetDeviceRetrieveCurrentFrameNumber retourne STATUS_SUCCESS si l’opération réussit. Sinon, cette méthode peut retourner l’une des valeurs suivantes :

Retourner le code	Description
STATUS_INVALID_PARAMETER	Un paramètre non valide a été détecté.
STATUS_UNSUCCESSFUL	Le numéro d’image n’était pas disponible, peut-être parce que les pilotes inférieurs ne fournissent pas de nombres d’images.

Cette méthode peut également retourner d’autres valeurs NTSTATUS .

Une vérification de bogue se produit si le pilote fournit un handle d’objet non valide.

Remarques

Pour plus d’informations sur la méthode WdfUsbTargetDeviceRetrieveCurrentFrameNumber et les cibles d’E/S USB, consultez cibles d’E/S USB.

Exemples

L’exemple de code suivant appelle WdfUsbTargetDeviceRetrieveCurrentFrameNumber. L’exemple obtient un handle d’objet de périphérique USB à partir de l’espace de contexte défini par le pilote.

ULONG  frameNumber;
PMY_DEVICE_CONTEXT  pMyDeviceContext;

pMyDeviceContext = GetDeviceContext(Device);

status = WdfUsbTargetDeviceRetrieveCurrentFrameNumber(
                                              pMyDeviceContext->UsbTargetDevice,
                                              &frameNumber
                                              );

Exigences

Exigence	Valeur
plateforme cible	Universel
version minimale de KMDF	1.0
d’en-tête	wdfusb.h (include Wdfusb.h)
bibliothèque	Wdf01000.sys (voir Versioning de la bibliothèque Framework.)
IRQL	<=DISPATCH_LEVEL
règles de conformité DDI	DriverCreate(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf), UsbKmdfIrql(kmdf), UsbKmdfIrql2(kmdf), UsbKmdfIrqlExplicit(kmdf)

Voir aussi

WdfUsbTargetDeviceCreateWithParameters

Partager via