Export (0) Print
Expand All

EvtSetChannelConfigProperty function

Sets the specified configuration property of a channel.

Syntax


BOOL WINAPI EvtSetChannelConfigProperty(
  _In_  EVT_HANDLE ChannelConfig,
  _In_  EVT_CHANNEL_CONFIG_PROPERTY_ID PropertyId,
  _In_  DWORD Flags,
  _In_  PEVT_VARIANT PropertyValue
);

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 set. For a list of property identifiers, see the EVT_CHANNEL_CONFIG_PROPERTY_ID enumeration.

Flags [in]

Reserved. Must be zero.

PropertyValue [in]

The property value to set.

A caller-allocated buffer that contains the new configuration property value. The buffer contains an EVT_VARIANT object. Be sure to set the configuration value and variant type.

Return value

Return code/valueDescription
TRUE

The function succeeded.

FALSE

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

 

Remarks

This function changes an in-memory copy of the configuration properties. To apply the changes that you have made to one or more of the configuration properties, call the EvtSaveChannelConfig 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

EvtGetChannelConfigProperty
EvtOpenChannelConfig
EvtSaveChannelConfig

 

 

Community Additions

ADD
Show:
© 2014 Microsoft