EvtNextChannelPath Function (Windows)

EvtNextChannelPath Function

EvtNextChannelPath Function

Gets a channel name from the enumerator.

Syntax

C++

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/value	Description
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