Использование инициализации One-Time

В следующих примерах показано использование однократных функций инициализации.

Синхронный пример

В этом примере глобальная переменная g_InitOnce представляет собой структуру инициализации для однократного использования. Он инициализирован статически с помощью INIT_ONCE_STATIC_INIT.

Функция OpenEventHandleSync возвращает дескриптор для события, созданного только один раз. Он вызывает функцию InitOnceExecuteOnce, чтобы выполнить код инициализации, содержащийся в функции обратного вызова InitHandleFunction. Если функция обратного вызова выполнена успешно, OpenEventHandleSync возвращает дескриптор событий, возвращенный в lpContext; в противном случае возвращается INVALID_HANDLE_VALUE.

Функция InitHandleFunction является функцией однократной инициализации (callback) . InitHandleFunction вызывает функцию CreateEvent для создания события и возвращает дескриптор события в параметре 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;
  }
}

Асинхронный пример

В этом примере глобальная переменная g_InitOnce является структурой инициализации, используемой однократно. Он инициализирован статически с помощью INIT_ONCE_STATIC_INIT.

Функция OpenEventHandleAsync возвращает идентификатор события, созданного только один раз. OpenEventHandleAsync вызывает функцию InitOnceBeginInitialize для ввода состояния инициализации.

Если вызов выполнен успешно, код проверяет значение параметра fPending, чтобы определить, следует ли создавать событие или просто возвращать дескриптор события, созданного другим потоком. Если fPendingfalse, инициализация уже завершена, поэтому OpenEventHandleAsync возвращает дескриптор событий, возвращенный в параметре lpContext. В противном случае вызывает функцию createEvent, чтобы создать событие и функцию InitOnceComplete, чтобы завершить инициализацию.

Если вызов InitOnceComplete выполнен успешно, OpenEventHandleAsync возвращает новый дескриптор событий. В противном случае он закрывает дескриптор события и вызывает InitOnceBeginInitialize с INIT_ONCE_CHECK_ONLY, чтобы определить, завершилась ли инициализация с ошибкой или была завершена другим потоком.

Если инициализация была завершена другим потоком, OpenEventHandleAsync возвращает дескриптор событий, возвращенный в lpContext. В противном случае возвращается 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;
  }
}

Связанные разделы

One-Time Инициализация