Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 3.35 KB

nf-pdh-pdhopenquerya.md

File metadata and controls

108 lines (75 loc) · 3.35 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:pdh.PdhOpenQueryA
PdhOpenQueryA function (pdh.h)
Creates a new query that is used to manage the collection of performance data. To use handles to data sources, use the PdhOpenQueryH function. (ANSI)
PdhOpenQueryA
pdh/PdhOpenQueryA
perf\pdhopenquery.htm
perf
ec4e5353-c7f5-4957-b7f4-39df508846a0
12/05/2018
PdhOpenQuery, PdhOpenQuery function [Perf], PdhOpenQueryA, PdhOpenQueryW, _win32_pdhopenquery, base.pdhopenquery, pdh/PdhOpenQuery, pdh/PdhOpenQueryA, pdh/PdhOpenQueryW, perf.pdhopenquery
pdh.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
PdhOpenQueryW (Unicode) and PdhOpenQueryA (ANSI)
Pdh.lib
Pdh.dll
Windows
19H1
PdhOpenQueryA
pdh/PdhOpenQueryA
c++
APIRef
kbSyntax
DllExport
Pdh.dll
PdhOpenQuery
PdhOpenQueryA
PdhOpenQueryW

PdhOpenQueryA function

-description

Creates a new query that is used to manage the collection of performance data.

To use handles to data sources, use the PdhOpenQueryH function.

-parameters

-param szDataSource [in]

Null-terminated string that specifies the name of the log file from which to retrieve performance data. If NULL, performance data is collected from a real-time data source.

-param dwUserData [in]

User-defined value to associate with this query. To retrieve the user data later, call PdhGetCounterInfo and access the dwQueryUserData member of PDH_COUNTER_INFO.

-param phQuery [out]

Handle to the query. You use this handle in subsequent calls.

-returns

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, the return value is a system error code or a PDH error code.

-see-also

PdhCloseQuery

PdhGetCounterInfo

PdhIsRealTimeQuery

PdhOpenQueryH

PdhSetDefaultRealTimeDataSource

-remarks

Note

The pdh.h header defines PdhOpenQuery as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.