Edit

ICorProfilerInfo12::EventPipeDefineEvent method

  • Article

Defines an EventPipe event on an existing provider. This provider can be used to write EventPipe events that other listeners can receive.

Syntax

    HRESULT EventPipeDefineEvent(
                [in] EVENTPIPE_PROVIDER     provider,
                [in, string] const WCHAR   *eventName,
                [in] UINT32                 eventID,
                [in] UINT64                 keywords,
                [in] UINT32                 eventVersion,
                [in] UINT32                 level,
                [in] UINT8                  opcode,
                [in] BOOL                   needStack,
                [in] UINT32                 cParamDescs,
                [in, size_is(cParamDescs)]
                     COR_PRF_EVENTPIPE_PARAM_DESC pParamDescs[],
                [out] EVENTPIPE_EVENT      *pEvent);

Parameters

provider
[in] The ID of the provider to define an event on.

eventName
[in] A pointer to a null terminated wide character string that contains the event name.

eventID
[in] The ID of the event being defined.

keywords
[in] The keywords of the event being defined.

eventVersion
[in] The version of the event being defined.

level
[in] The level of the event being defined.

opcode
[in] The opcode of the event being defined.

needStack
[in] A BOOL indicating whether managed stacks should be collected each time this event fires.

cParamDescs
[in] The count of the number of parameters in pParamDescs.

pParamDescs
[in] An array of COR_PRF_EVENTPIPE_PARAM_DESC defining the parameter types to the event being defined.

pEvent
[out] A caller provided pointer that will be filled with the ID of the event being defined when the function returns.

Requirements

Platforms: See .NET supported operating systems.

Header: CorProf.idl, CorProf.h

.NET Versions: Available since .NET 5.0

See also