Edit

Share via

ID3D11Device::CheckCounter method (d3d11.h)

  • Article

Get the type, name, units of measure, and a description of an existing counter.

Syntax

HRESULT CheckCounter(
  [in]                const D3D11_COUNTER_DESC *pDesc,
  [out]               D3D11_COUNTER_TYPE       *pType,
  [out]               UINT                     *pActiveCounters,
  [out, optional]     LPSTR                    szName,
  [in, out, optional] UINT                     *pNameLength,
  [out, optional]     LPSTR                    szUnits,
  [in, out, optional] UINT                     *pUnitsLength,
  [out, optional]     LPSTR                    szDescription,
  [in, out, optional] UINT                     *pDescriptionLength
);

Parameters

[in] pDesc

Type: const D3D11_COUNTER_DESC*

Pointer to a counter description (see D3D11_COUNTER_DESC). Specifies which counter information is to be retrieved about.

[out] pType

Type: D3D11_COUNTER_TYPE*

Pointer to the data type of a counter (see D3D11_COUNTER_TYPE). Specifies the data type of the counter being retrieved.

[out] pActiveCounters

Type: UINT*

Pointer to the number of hardware counters that are needed for this counter type to be created. All instances of the same counter type use the same hardware counters.

[out, optional] szName

Type: LPSTR

String to be filled with a brief name for the counter. May be NULL if the application is not interested in the name of the counter.

[in, out, optional] pNameLength

Type: UINT*

Length of the string returned to szName. Can be NULL.

[out, optional] szUnits

Type: LPSTR

Name of the units a counter measures, provided the memory the pointer points to has enough room to hold the string. Can be NULL. The returned string will always be in English.

[in, out, optional] pUnitsLength

Type: UINT*

Length of the string returned to szUnits. Can be NULL.

[out, optional] szDescription

Type: LPSTR

A description of the counter, provided the memory the pointer points to has enough room to hold the string. Can be NULL. The returned string will always be in English.

[in, out, optional] pDescriptionLength

Type: UINT*

Length of the string returned to szDescription. Can be NULL.

Return value

Type: HRESULT

This method returns one of the following Direct3D 11 Return Codes.

Remarks

Length parameters can be NULL, which indicates the application is not interested in the length nor the corresponding string value. When a length parameter is non-NULL and the corresponding string is NULL, the input value of the length parameter is ignored, and the length of the corresponding string (including terminating NULL) will be returned through the length parameter. When length and the corresponding parameter are both non-NULL, the input value of length is checked to ensure there is enough room, and then the length of the string (including terminating NULL character) is passed out through the length parameter.

Windows Phone 8: This API is supported.

Requirements

Requirement Value
Target Platform Windows
Header d3d11.h
Library D3D11.lib

See also

ID3D11Device