Функция QueryActCtxW (winbase.h)

Функция QueryActCtxW запрашивает контекст активации.

Синтаксис

BOOL QueryActCtxW(
  [in]            DWORD  dwFlags,
  [in]            HANDLE hActCtx,
  [in, optional]  PVOID  pvSubInstance,
  [in]            ULONG  ulInfoClass,
  [out]           PVOID  pvBuffer,
  [in, optional]  SIZE_T cbBuffer,
  [out, optional] SIZE_T *pcbWrittenOrRequired
);

Параметры

[in] dwFlags

Для этого параметра следует задать один из следующих битов флага.

[in] hActCtx

Обработка контекста активации, к которому выполняется запрос.

[in, optional] pvSubInstance

Индекс сборки или комбинации сборки и файла в контексте активации. Значение pvSubInstance зависит от параметра, заданного значением параметра ulInfoClass .

Этот параметр может быть равен null.

[in] ulInfoClass

Этот параметр может иметь только значения, показанные в следующей таблице.

[out] pvBuffer

Указатель на буфер, содержащий возвращаемые сведения. Этот параметр является необязательным. Если pvBuffer имеет значение NULL, то cbBuffer должен быть равен нулю. Если размер буфера, на который указывает pvBuffer , слишком мал, QueryActCtxW возвращает ERROR_INSUFFICIENT_BUFFER и никакие данные не записываются в буфер. Метод, который можно использовать для определения требуемого размера буфера, см. в разделе Примечания.

[in, optional] cbBuffer

Размер буфера в байтах, на который указывает pvBuffer. Этот параметр является необязательным.

[out, optional] pcbWrittenOrRequired

Число записанных или обязательных байтов. Параметр pcbWrittenOrRequired может иметь значение NULL , только если pvBuffer имеет значение NULL. Если pcbWrittenOrRequired имеет значение, отличное от NULL, он заполняется количеством байтов, необходимым для хранения возвращаемого буфера.

Возвращаемое значение

Если функция выполняется успешно, возвращается значение TRUE. В противном случае возвращается значение FALSE.

Эта функция задает ошибки, которые можно получить, вызвав Метод GetLastError. Пример см. в разделе Извлечение кода Last-Error. Полный список кодов ошибок см. в разделе Системные коды ошибок.

Комментарии

Параметр cbBuffer задает размер буфера в байтах, на который указывает pvBuffer. Если pvBuffer имеет значение NULL, то cbBuffer должен иметь значение 0. Параметр pcbWrittenOrRequired может иметь значение NULL , только если pvBuffer имеет значение NULL. Если при возврате pcbWrittenOrRequired имеет значение, отличное от NULL , оно заполняется количеством байтов, необходимым для хранения возвращаемых сведений. Если возвращаемые данные больше предоставленного буфера, QueryActCtxW возвращает ERROR_INSUFFICIENT_BUFFER и данные не записываются в буфер, на который указывает pvBuffer.

В следующем примере показан метод вызова сначала с небольшим буфером, а затем для вызова, если буфер слишком мал.

SIZE_T cbRequired;
PVOID pvData = NULL;
SIZE_T cbAvailable = 0;

if (!QueryActCtxW(..., pvData, cbAvailable, &cbRequired) && (GetLastError()== ERROR_INSUFFICIENT_BUFFER))
{
    // Allocate enough space to store the returned buffer, fail if too small
    if (NULL == (pvData = HeapAlloc(GetProcessHeap(), 0, cbRequired)))
    {
        SetLastError(ERROR_NOT_ENOUGH_MEMORY);
        return FALSE;
    }
    cbAvailable = cbRequired;
    // Try again, this should succeed.
    if (QueryActCtxW(..., pvData, cbAvailable, &cbRequired))
    {
        // Use the returned data in pvData
    }
    HeapFree(GetProcessHeap(), 0, pvData);
    pvData = NULL;
}

Требования