TdhEnumerateProviderFieldInformation 関数 (tdh.h)
指定されたプロバイダーの指定されたフィールド メタデータを取得します。
構文
TDHSTATUS TdhEnumerateProviderFieldInformation(
[in] LPGUID pGuid,
[in] EVENT_FIELD_TYPE EventFieldType,
[out, optional] PPROVIDER_FIELD_INFOARRAY pBuffer,
[in, out] ULONG *pBufferSize
);
パラメーター
[in] pGuid
情報を取得するプロバイダーを識別する GUID。
[in] EventFieldType
情報を取得するフィールドの種類を指定します。 使用可能な値については、 EVENT_FIELD_TYPE 列挙を参照してください。
[out, optional] pBuffer
フィールド情報を受け取るユーザー割り当てバッファー。 詳細については、PROVIDER_FIELD_INFOARRAY構造に 関 するページを参照してください。
[in, out] pBufferSize
pBuffer バッファーのサイズ (バイト単位)。 関数が成功した場合、このパラメーターは使用されるバッファーのサイズを受け取ります。 バッファーが小さすぎる場合、関数は ERROR_INSUFFICIENT_BUFFERを返し、このパラメーターを必要なバッファー サイズに設定します。 入力時にバッファー サイズが 0 の場合、バッファーにデータは返されません。このパラメーターは必要なバッファー サイズを受け取ります。
戻り値
成功した場合は、ERROR_SUCCESSを返します。 それ以外の場合、この関数は、他の戻りコードに加えて、次のいずれかのリターン コードを返します。
| リターン コード | 説明 |
|---|---|
|
pBuffer バッファーのサイズが小さすぎます。 新しいバッファーを割り当てるには、 pBufferSize で必要なバッファー サイズ セットを使用します。 |
|
要求されたフィールド型が無効です。 |
|
マニフェストまたは MOF クラスが見つからないか、要求されたフィールド型の情報が含まれていません。 |
|
1 つ以上のパラメーターが無効です。 |
|
マニフェストの resourceFileName 属性には、プロバイダー バイナリの場所が含まれています。 マニフェストを登録すると、場所がレジストリに書き込まれます。 TDH は、登録された場所に基づいてバイナリを見つけることができませんでした。 |
注釈
この関数は、XML マニフェストまたは WMI MOF クラスを使用して情報を取得します。
例
次の例は、要求されたフィールドのマニフェストまたは MOF クラスに含まれる情報を列挙する方法を示しています。
#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;
}
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | tdh.h |
| Library | Tdh.lib |
| [DLL] | Tdh.dll |