Export (0) Print
Expand All

EvtOpenChannelConfig function

Gets a handle that you use to read or modify a channel's configuration property.

Syntax


EVT_HANDLE WINAPI EvtOpenChannelConfig(
  _In_  EVT_HANDLE Session,
  _In_  LPCWSTR ChannelPath,
  _In_  DWORD Flags
);

Parameters

Session [in]

A remote session handle that the EvtOpenSession function returns. Set to NULL to access a channel on the local computer.

ChannelPath [in]

The name of the channel to access.

Flags [in]

Reserved. Must be zero.

Return value

If successful, the function returns a handle to the channel's configuration; otherwise, NULL. If NULL, call GetLastError function to get the error code.

Remarks

To get a configuration property, call the EvtGetChannelConfigProperty function.

To modify a configuration property, call the EvtSetChannelConfigProperty function. To save the configuration changes, call the EvtSaveChannelConfig function.

To enumerate the registered channels, call the EvtOpenChannelEnum function.

You must call the EvtClose function to close the handle when done.

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
EvtOpenChannelEnum
EvtSetChannelConfigProperty
EvtSaveChannelConfig

 

 

Community Additions

ADD
Show:
© 2015 Microsoft