Export (0) Print
Expand All

EvtGetChannelConfigProperty function

Gets the specified channel configuration property.

Syntax


BOOL WINAPI EvtGetChannelConfigProperty(
  _In_   EVT_HANDLE ChannelConfig,
  _In_   EVT_CHANNEL_CONFIG_PROPERTY_ID PropertyId,
  _In_   DWORD Flags,
  _In_   DWORD PropertyValueBufferSize,
  _In_   PEVT_VARIANT PropertyValueBuffer,
  _Out_  PDWORD PropertyValueBufferUsed
);

Parameters

ChannelConfig [in]

A handle to the channel's configuration properties that the EvtOpenChannelConfig function returns.

PropertyId [in]

The identifier of the channel property to retrieve. For a list of property identifiers, see the EVT_CHANNEL_CONFIG_PROPERTY_ID enumeration.

Flags [in]

Reserved. Must be zero.

PropertyValueBufferSize [in]

The size of the PropertyValueBuffer buffer, in bytes.

PropertyValueBuffer [in]

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

PropertyValueBufferUsed [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 and Setting a Channel's Configuration Properties.

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

EvtOpenChannelConfig

 

 

Community Additions

ADD
Show:
© 2014 Microsoft