WdfTimerCreate, fonction (wdftimer.h)

[S’applique à KMDF et UMDF]

La méthode WdfTimerCreate crée un objet de minuteur d’infrastructure.

Syntaxe

NTSTATUS WdfTimerCreate(
  [in]  PWDF_TIMER_CONFIG      Config,
  [in]  PWDF_OBJECT_ATTRIBUTES Attributes,
  [out] WDFTIMER               *Timer
);

Paramètres

[in] Config

Pointeur vers une structure WDF_TIMER_CONFIG .

[in] Attributes

Pointeur vers une structure WDF_OBJECT_ATTRIBUTES qui contient des attributs d’objet pour le nouvel objet minuteur.

[out] Timer

Pointeur vers un emplacement qui reçoit un handle vers le nouvel objet du minuteur d’infrastructure.

Valeur retournée

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

Pour obtenir la liste d’autres valeurs de retour que la méthode WdfTimerCreate peut retourner, consultez Erreurs de création d’objets Framework.

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

Remarques

Lorsque votre pilote appelle WdfTimerCreate, il doit fournir une structure WDF_OBJECT_ATTRIBUTES et spécifier un objet parent dans le membre ParentObject de la structure. L’objet parent peut être un objet d’appareil framework ou tout objet dont la chaîne de parents conduit à un objet d’appareil framework. L’infrastructure supprime l’objet minuteur lorsqu’il supprime l’objet d’appareil.

Après avoir créé un objet minuteur, le pilote doit appeler WdfTimerStart pour démarrer l’horloge du minuteur, que le minuteur soit périodique ou non.

Si votre pilote fournit des fonctions de rappel EvtCleanupCallback ou EvtDestroyCallback pour l’objet du minuteur d’infrastructure, notez que l’infrastructure appelle ces fonctions de rappel à IRQL = PASSIVE_LEVEL.

Pour plus d’informations sur les objets du minuteur de framework, consultez Utilisation des minuteurs.

Examples

L’exemple de code suivant initialise une structure WDF_TIMER_CONFIG et une structure WDF_OBJECT_ATTRIBUTES , puis appelle WdfTimerCreate.

WDF_TIMER_CONFIG  timerConfig;
WDF_OBJECT_ATTRIBUTES  timerAttributes;
WDFTIMER  timerHandle;
NTSTATUS  status;

WDF_TIMER_CONFIG_INIT(
                      &timerConfig,
                      MyEvtTimerFunc
                      );

// Consider allowing a tolerance for the due time and period.
// For more information on no-wake timers and timer coalescing, see:
// https://dotnet.territoriali.olinfo.it/en-us/windows-hardware/drivers/kernel/no-wake-timers
timerConfig.TolerableDelay = 10;

WDF_OBJECT_ATTRIBUTES_INIT(&timerAttributes);
timerAttributes.ParentObject = DeviceHandle;

status = WdfTimerCreate(
                        &timerConfig,
                        &timerAttributes,
                        &timerHandle
                        );

if (!NT_SUCCESS(status)) {
    return status;
}

Spécifications

Voir aussi

• WDF_OBJECT_ATTRIBUTES
• WDF_OBJECT_ATTRIBUTES_INIT
• WDF_TIMER_CONFIG
• WDF_TIMER_CONFIG_INIT
• WdfTimerStart