Utilisation de One-Time Initialisation

Les exemples suivants illustrent l’utilisation des fonctions d’initialisation à usage unique.

Exemple synchrone

Dans cet exemple, la g_InitOnce variable globale est la structure d’initialisation à usage unique. Il est initialisé statiquement à l’aide de INIT_ONCE_STATIC_INIT.

La OpenEventHandleSync fonction retourne un handle à un événement qui n’est créé qu’une seule fois. Il appelle la fonction InitOnceExecuteOnce pour exécuter le code d’initialisation contenu dans la InitHandleFunction fonction de rappel. Si la fonction de rappel réussit, OpenEventHandleSync retourne le handle d’événement retourné dans lpContext ; sinon, elle retourne INVALID_HANDLE_VALUE.

La InitHandleFunction fonction est la fonction de rappel d’initialisation à usage unique. InitHandleFunction appelle la fonction CreateEvent pour créer l’événement et retourne le handle d’événement dans le paramètre lpContext .

#define _WIN32_WINNT 0x0600
#include <windows.h>

// Global variable for one-time initialization structure
INIT_ONCE g_InitOnce = INIT_ONCE_STATIC_INIT; // Static initialization

// Initialization callback function 
BOOL CALLBACK InitHandleFunction (
    PINIT_ONCE InitOnce,        
    PVOID Parameter,            
    PVOID *lpContext);           

// Returns a handle to an event object that is created only once
HANDLE OpenEventHandleSync()
{
  PVOID lpContext;
  BOOL  bStatus;
  
  // Execute the initialization callback function 
  bStatus = InitOnceExecuteOnce(&g_InitOnce,          // One-time initialization structure
                                InitHandleFunction,   // Pointer to initialization callback function
                                NULL,                 // Optional parameter to callback function (not used)
                                &lpContext);          // Receives pointer to event object stored in g_InitOnce

  // InitOnceExecuteOnce function succeeded. Return event object.
  if (bStatus)
  {
    return (HANDLE)lpContext;
  }
  else
  {
    return (INVALID_HANDLE_VALUE);
  }
}

// Initialization callback function that creates the event object 
BOOL CALLBACK InitHandleFunction (
    PINIT_ONCE InitOnce,        // Pointer to one-time initialization structure        
    PVOID Parameter,            // Optional parameter passed by InitOnceExecuteOnce            
    PVOID *lpContext)           // Receives pointer to event object           
{
  HANDLE hEvent;

  // Create event object
  hEvent = CreateEvent(NULL,    // Default security descriptor
                       TRUE,    // Manual-reset event object
                       TRUE,    // Initial state of object is signaled 
                       NULL);   // Object is unnamed

  // Event object creation failed.
  if (NULL == hEvent)
  {
    return FALSE;
  }
  // Event object creation succeeded.
  else
  {
    *lpContext = hEvent;
    return TRUE;
  }
}

Exemple asynchrone

Dans cet exemple, la g_InitOnce variable globale est la structure d’initialisation à usage unique. Il est initialisé statiquement à l’aide de INIT_ONCE_STATIC_INIT.

La OpenEventHandleAsync fonction retourne un handle à un événement qui n’est créé qu’une seule fois. OpenEventHandleAsync appelle la fonction InitOnceBeginInitialize pour entrer l’état d’initialisation.

Si l’appel réussit, le code vérifie la valeur du paramètre fPending pour déterminer s’il faut créer l’événement ou simplement retourner un handle à l’événement créé par un autre thread. Si fPending a la valeur FALSE, l’initialisation étant déjà terminée OpenEventHandleAsync , retourne le handle d’événement retourné dans le paramètre lpContext . Sinon, il appelle la fonction CreateEvent pour créer l’événement et la fonction InitOnceComplete pour terminer l’initialisation.

Si l’appel à InitOnceComplete réussit, OpenEventHandleAsync retourne le nouveau handle d’événement. Sinon, il ferme le handle d’événement et appelle InitOnceBeginInitialize avec INIT_ONCE_CHECK_ONLY pour déterminer si l’initialisation a échoué ou a été terminée par un autre thread.

Si l’initialisation a été effectuée par un autre thread, OpenEventHandleAsync retourne le handle d’événement retourné dans lpContext. Sinon, il retourne INVALID_HANDLE_VALUE.

#define _WIN32_WINNT 0x0600
#include <windows.h>

// Global variable for one-time initialization structure
INIT_ONCE g_InitOnce = INIT_ONCE_STATIC_INIT; // Static initialization

// Returns a handle to an event object that is created only once
HANDLE OpenEventHandleAsync()
{
  PVOID  lpContext;
  BOOL   fStatus;
  BOOL   fPending;
  HANDLE hEvent;
  
  // Begin one-time initialization
  fStatus = InitOnceBeginInitialize(&g_InitOnce,       // Pointer to one-time initialization structure
                                    INIT_ONCE_ASYNC,   // Asynchronous one-time initialization
                                    &fPending,         // Receives initialization status
                                    &lpContext);       // Receives pointer to data in g_InitOnce  

  // InitOnceBeginInitialize function failed.
  if (!fStatus)
  {
    return (INVALID_HANDLE_VALUE);
  }

  // Initialization has already completed and lpContext contains event object.
  if (!fPending)
  {
    return (HANDLE)lpContext;
  }

  // Create event object for one-time initialization.
  hEvent = CreateEvent(NULL,    // Default security descriptor
                       TRUE,    // Manual-reset event object
                       TRUE,    // Initial state of object is signaled 
                       NULL);   // Object is unnamed

  // Event object creation failed.
  if (NULL == hEvent)
  {
    return (INVALID_HANDLE_VALUE);
  }

  // Complete one-time initialization.
  fStatus = InitOnceComplete(&g_InitOnce,             // Pointer to one-time initialization structure
                             INIT_ONCE_ASYNC,         // Asynchronous initialization
                             (PVOID)hEvent);          // Pointer to event object to be stored in g_InitOnce

  // InitOnceComplete function succeeded. Return event object.
  if (fStatus)
  {
    return hEvent;
  }
  
  // Initialization has already completed. Free the local event.
  CloseHandle(hEvent);


  // Retrieve the final context data.
  fStatus = InitOnceBeginInitialize(&g_InitOnce,            // Pointer to one-time initialization structure
                                    INIT_ONCE_CHECK_ONLY,   // Check whether initialization is complete
                                    &fPending,              // Receives initialization status
                                    &lpContext);            // Receives pointer to event object in g_InitOnce
  
  // Initialization is complete. Return handle.
  if (fStatus && !fPending)
  {
    return (HANDLE)lpContext;
  }
  else
  {
    return INVALID_HANDLE_VALUE;
  }
}

Rubriques connexes

Initialisation ponctuelle