Função TdhEnumerateProviderFieldInformation (tdh.h)

Recupera os metadados de campo especificados para um determinado provedor.

Sintaxe

TDHSTATUS TdhEnumerateProviderFieldInformation(
  [in]            LPGUID                    pGuid,
  [in]            EVENT_FIELD_TYPE          EventFieldType,
  [out, optional] PPROVIDER_FIELD_INFOARRAY pBuffer,
  [in, out]       ULONG                     *pBufferSize
);

Parâmetros

[in] pGuid

GUID que identifica o provedor cujas informações você deseja recuperar.

[in] EventFieldType

Especifique o tipo de campo para o qual você deseja recuperar informações. Para obter valores possíveis, consulte a enumeração EVENT_FIELD_TYPE .

[out, optional] pBuffer

Buffer alocado pelo usuário para receber as informações do campo. Para obter detalhes, consulte a estrutura PROVIDER_FIELD_INFOARRAY .

[in, out] pBufferSize

Tamanho, em bytes, do buffer pBuffer . Se a função for bem-sucedida, esse parâmetro receberá o tamanho do buffer usado. Se o buffer for muito pequeno, a função retornará ERROR_INSUFFICIENT_BUFFER e definirá esse parâmetro para o tamanho do buffer necessário. Se o tamanho do buffer for zero na entrada, nenhum dado será retornado no buffer e esse parâmetro receberá o tamanho do buffer necessário.

Retornar valor

Retorna ERROR_SUCCESS se tiver êxito. Caso contrário, essa função retornará um dos seguintes códigos de retorno, além de outros.

Código de retorno	Descrição
ERROR_INSUFFICIENT_BUFFER	O tamanho do buffer pBuffer é muito pequeno. Use o conjunto de tamanho de buffer necessário no pBufferSize para alocar um novo buffer.
ERROR_NOT_SUPPORTED	O tipo de campo solicitado não é válido.
ERROR_NOT_FOUND	O manifesto ou classe MOF não foi encontrado ou não contém informações para o tipo de campo solicitado.
ERROR_INVALID_PARAMETER	Um ou mais dos parâmetros não são válidos.
ERROR_FILE_NOT_FOUND	O atributo resourceFileName no manifesto contém o local do binário do provedor. Quando você registra o manifesto, o local é gravado no registro. O TDH não pôde localizar o binário com base no local registrado.

Comentários

Essa função usa o manifesto XML ou a classe MOF WMI para recuperar as informações.

Exemplos

O exemplo a seguir mostra como enumerar informações contidas no manifesto ou na classe MOF para o campo solicitado.

#include <windows.h>
#include <stdio.h>
#include <wmistr.h>
#include <evntrace.h>
#include <tdh.h>

#pragma comment(lib, "tdh.lib")

DWORD EnumFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType);

// GUID of the provider whose metadata you want to enumerate.

EXTERN_C __declspec(selectany) const GUID ProviderGuid = {0xd8909c24, 0x5be9, 0x4502, {0x98, 0xca, 0xab, 0x7b, 0xdc, 0x24, 0x89, 0x9d}};

void wmain(void)
{
    DWORD status = ERROR_SUCCESS;

    // Retrieve the keyword information.

    wprintf(L"Retrieve EventKeywordInformation\n");

    status = EnumFieldInfo((LPGUID)&ProviderGuid, EventKeywordInformation);
    if (ERROR_SUCCESS != status)
    {
        wprintf(L"Failed to retrieve EventKeywordInformation (%lu).\n\n", status);
    }
}

// Prints the information associated with the specified field type.
DWORD EnumFieldInfo(LPGUID pProvider, EVENT_FIELD_TYPE fieldType)
{
    DWORD status = ERROR_SUCCESS;
    PROVIDER_FIELD_INFOARRAY* penum = NULL;
    DWORD bufferSize = 0;

    // Retrieve the required buffer size. If the status is ERROR_INSUFFICIENT_BUFFER,
    // use bufferSize to allocate the buffer.

    status = TdhEnumerateProviderFieldInformation(pProvider, fieldType, penum, &bufferSize);
    if (ERROR_INSUFFICIENT_BUFFER == status)
    {
        penum = (PROVIDER_FIELD_INFOARRAY*) malloc(bufferSize);
        if (penum == NULL)
        {
            wprintf(L"Allocation failed (size=%lu).\n", bufferSize);
            status = ERROR_OUTOFMEMORY;
            goto cleanup;
        }

        // Retrieve the information for the field type.

        status = TdhEnumerateProviderFieldInformation(pProvider, fieldType, penum, &bufferSize);
    }

    // The first call can fail with ERROR_NOT_FOUND if none of the provider's event
    // descriptions contain the requested field type information.

    if (ERROR_SUCCESS == status)
    {
        // Loop through the list of field information and print the field's name,
        // description (if it exists), and value. 

        for (DWORD i = 0; i < penum->NumberOfElements; i++)
        {
            wprintf(L"Field name: %s\nDescription: %s\nValue: %I64u\n\n",
                (PWCHAR)((PBYTE)(penum) + penum->FieldInfoArray[i].NameOffset),
                (penum->FieldInfoArray[i].DescriptionOffset) ? 
                    (PWCHAR)((PBYTE)(penum) + penum->FieldInfoArray[i].DescriptionOffset): L"",
                penum->FieldInfoArray[i].Value);
        }
    }
    else
    {
        if (ERROR_NOT_FOUND == status)
        {
            wprintf(L"Requested field type not found.\n");
        }
        else
        {
            wprintf(L"TdhEnumerateProviderFieldInformation failed with %lu.\n", status);
        }

        goto cleanup;
    }

cleanup:

    if (penum)
    {
        free(penum);
        penum = NULL;
    }

    return status;
}

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tdh.h
Biblioteca	Tdh.lib
DLL	Tdh.dll

Confira também

TdhEnumerateProviders

TdhQueryProviderFieldInformation