WdfUsbTargetDeviceRetrieveCurrentFrameNumber, fonction (wdfusb.h)

Article
02/29/2024

[S’applique à KMDF uniquement]

La méthode WdfUsbTargetDeviceRetrieveCurrentFrameNumber récupère le numéro de frame USB actuel.

Syntaxe

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

Paramètres

[in] UsbDevice

Handle pour 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 de cadre USB 32 bits actuel.

Valeur retournée

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

Code de retour	Description
STATUS_INVALID_PARAMETER	Un paramètre non valide a été détecté.
STATUS_UNSUCCESSFUL	Le numéro de trame n’était pas disponible, peut-être parce que les pilotes inférieurs ne fournissent pas de numéros de trame.

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

Un bogue case activée 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 contextuel défini par le pilote.

ULONG  frameNumber;
PMY_DEVICE_CONTEXT  pMyDeviceContext;

pMyDeviceContext = GetDeviceContext(Device);

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

Configuration requise

Condition requise	Valeur
Plateforme cible	Universal
Version KMDF minimale	1.0
En-tête	wdfusb.h (inclure Wdfusb.h)
Bibliothèque	Wdf01000.sys (consultez Gestion des versions de la bibliothèque d’infrastructure).)
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