EvtNextChannelPath function

Gets a channel name from the enumerator.

Syntax


BOOL WINAPI EvtNextChannelPath(
  _In_  EVT_HANDLE ChannelEnum,
  _In_  DWORD      ChannelPathBufferSize,
  _In_  LPWSTR     ChannelPathBuffer,
  _Out_ PDWORD     ChannelPathBufferUsed
);

Parameters

ChannelEnum [in]

A handle to the enumerator that the EvtOpenChannelEnum function returns.

ChannelPathBufferSize [in]

The size of the ChannelPathBuffer buffer, in characters.

ChannelPathBuffer [in]

A caller-allocated buffer that will receive the name of the channel. You can set this parameter to NULL to determine the required buffer size.

ChannelPathBufferUsed [out]

The size, in characters, 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.

 

Remarks

Call this function in a loop until the function returns FALSE and the error code is ERROR_NO_MORE_ITEMS.

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

EvtOpenChannelEnum

 

 

Show: