TraceQueryInformation function
The TraceQueryInformation function queries event tracing session settings for the specified information class.
Syntax
ULONG WINAPI TraceQueryInformation( _In_ TRACEHANDLE SessionHandle, _In_ TRACE_QUERY_INFO_CLASS InformationClass, _Out_ PVOID TraceInformation, _In_ ULONG InformationLength, _Out_opt_ PULONG ReturnLength );
Parameters
- SessionHandle [in]
-
A handle of the event tracing session that wants to capture the specified information. The StartTrace function returns this handle.
- InformationClass [in]
-
The information class to query. The information that the class captures is included in the extended data section of the event. For a list of information classes that you can query, see the TRACE_QUERY_INFO_CLASS enumeration.
- TraceInformation [out]
-
A pointer to a buffer to receive the returned information class specific data. The information class determines the contents of this parameter. For example, for the TraceStackTracingInfo information class, this parameter is an array of CLASSIC_EVENT_ID structures. The structures specify the event GUIDs for which stack tracing is enabled. The array is limited to 256 elements.
- InformationLength [in]
-
The size, in bytes, of the data returned in the TraceInformation buffer. If the function fails, this value indicates the required size of the TraceInformation buffer that is needed.
- ReturnLength [out, optional]
-
A pointer a value that receives the size, in bytes, of the specific data returned in the TraceInformation buffer.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value is one of the following error codes.
| Return code | Description |
|---|---|
|
The program issued a command but the command length is incorrect. This error is returned if the InformationLength parameter is less than a minimum size. |
|
The parameter is incorrect. |
|
The request is not supported. |
|
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The TraceQueryInformation function queries event tracing session settings for the specified information class. Call this function after calling StartTrace.
Requirements
|
Minimum supported client |
Windows 8 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2012 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also