EvtGetObjectArrayProperty 函式 (winevt.h)

從陣列中指定的物件取得提供者元資料屬性。

語法

BOOL EvtGetObjectArrayProperty(
  [in]  EVT_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  DWORD                            PropertyId,
  [in]  DWORD                            ArrayIndex,
  [in]  DWORD                            Flags,
  [in]  DWORD                            PropertyValueBufferSize,
  [in]  PEVT_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                           PropertyValueBufferUsed
);

參數

[in] ObjectArray

EvtGetPublisherMetadataProperty 函式傳回之對象的陣列句柄。

[in] PropertyId

您要從指定物件取得之元資料屬性的屬性識別碼。 如需可能的值，請參閱 EVT_PUBLISHER_METADATA_PROPERTY_ID的一節。

[in] ArrayIndex

陣列中物件以零起始的索引。

[in] Flags

保留的。 必須為零。

[in] PropertyValueBufferSize

PropertyValueBuffer 緩衝區的大小，以位元組為單位。

[in] PropertyValueBuffer

將接收元數據屬性的呼叫端配置緩衝區。 緩衝區包含 EVT_VARIANT 物件。 您可以將此參數設定為 NULL ，以判斷所需的緩衝區大小。

[out] PropertyValueBufferUsed

如果函式因ERROR_INSUFFICIENT_BUFFER而失敗，則呼叫端配置緩衝區的大小，或是所需的緩衝區大小。

傳回值

傳回碼/值	Description
TRUE	此函數已成功。
FALSE	函式失敗。 若要取得錯誤碼，請呼叫 GetLastError 函式。

備註

當您使用下列標識符呼叫 EvtGetPublisherMetadataProperty 函式時，函式會傳回該類型物件的數位句柄：

• EvtPublisherMetadataChannelReferences
• EvtPublisherMetadataLevels
• EvtPublisherMetadataTasks
• EvtPublisherMetadataOpcodes
• EvtPublisherMetadataKeywords

例如，如果您將 EvtPublisherMetadataKeywords 傳遞給 EvtGetPublisherMetadataProperty，函式會將句柄傳回關鍵詞對象的陣列。

若要判斷數位的大小，請呼叫 EvtGetObjectArraySize 函式。

範例

如需示範如何使用此函式的範例，請參閱 取得提供者的元數據。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	winevt.h
程式庫	Wevtapi.lib
Dll	Wevtapi.dll

另請參閱

EVT_PUBLISHER_METADATA_PROPERTY_ID

EvtGetPublisherMetadataProperty