EvtGetEventMetadataProperty

EvtGetEventMetadataProperty function

Gets the specified event metadata property.

Syntax


BOOL WINAPI EvtGetEventMetadataProperty(
  _In_  EVT_HANDLE                     EventMetadata,
  _In_  EVT_EVENT_METADATA_PROPERTY_ID PropertyId,
  _In_  DWORD                          Flags,
  _In_  DWORD                          EventMetadataPropertyBufferSize,
  _In_  PEVT_VARIANT                   EventMetadataPropertyBuffer,
  _Out_ PDWORD                         EventMetadataPropertyBufferUsed
);

Parameters

EventMetadata [in]

A handle to the event metadata that the EvtNextEventMetadata function returns.

PropertyId [in]

The identifier of the metadata property to retrieve. For a list of property identifiers, see the EVT_EVENT_METADATA_PROPERTY_ID enumeration.

Flags [in]

Reserved. Must be zero.

EventMetadataPropertyBufferSize [in]

The size of the EventMetadataPropertyBuffer buffer, in bytes.

EventMetadataPropertyBuffer [in]

A caller-allocated buffer that will receive the metadata property. The buffer contains an EVT_VARIANT object. You can set this parameter to NULL to determine the required buffer size.

EventMetadataPropertyBufferUsed [out]

The size, in bytes, of the caller-allocated buffer that the function used or the required buffer size if the function fails with ERROR_INSUFFICIENT_BUFFER.

Return value

Return code/valueDescription
TRUE

The function succeeded.

FALSE

The function failed. To get the error code, call the GetLastError function.

 

Examples

For an example that shows how to use this function, see Getting a Provider's Metadata.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WinEvt.h

Library

Wevtapi.lib

DLL

Wevtapi.dll

See also

EvtGetPublisherMetadataProperty
EvtNextEventMetadata

 

 

Show:
© 2016 Microsoft