Función PdhGetDefaultPerfCounterA (pdh.h)

Recupera el nombre del contador predeterminado para el objeto especificado. Este nombre se puede usar para establecer la selección inicial del contador en el cuadro de diálogo Examinar contador.

Para usar identificadores para orígenes de datos, use la función PdhGetDefaultPerfCounterH.

Sintaxis

PDH_FUNCTION PdhGetDefaultPerfCounterA(
  [in]      LPCSTR  szDataSource,
  [in]      LPCSTR  szMachineName,
  [in]      LPCSTR  szObjectName,
  [out]     LPSTR   szDefaultCounterName,
  [in, out] LPDWORD pcchBufferSize
);

Parámetros

[in] szDataSource

Debe ser null.

Si especifica un archivo de registro, szDefaultCounterName será una cadena null.

[in] szMachineName

cadena terminada en Nullque especifica el nombre del equipo usado para comprobar el nombre del objeto. Si null, el equipo local se usa para comprobar el nombre del objeto.

[in] szObjectName

cadena terminada en Nullque especifica el nombre del objeto cuyo nombre de contador predeterminado desea recuperar.

[out] szDefaultCounterName

Búfer asignado por el autor de la llamada que recibe el nombre de contador predeterminadonulo. Establézcalo en NULL si pcchBufferSize es cero.

[in, out] pcchBufferSize

Tamaño del búfer de szDefaultCounterName, en TCHAR. Si es cero en la entrada, la función devuelve PDH_MORE_DATA y establece este parámetro en el tamaño de búfer necesario. Si el búfer es mayor que el tamaño necesario, la función establece este parámetro en el tamaño real del búfer que se usó. Si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario, no debe confiar en el tamaño devuelto para reasignar el búfer.

Valor devuelto

Si la función se ejecuta correctamente, devuelve ERROR_SUCCESS.

Si se produce un error en la función, el valor devuelto es un código de error del sistema o un código de error PDH . A continuación se muestran los valores posibles.

Código devuelto	Descripción
PDH_MORE_DATA	El szDefaultCounterName búfer es demasiado pequeño para contener el nombre del contador. Este valor devuelto se espera si pcchBufferSize es cero en la entrada. Si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario, no debe confiar en el tamaño devuelto para reasignar el búfer.
PDH_INVALID_ARGUMENT	Un parámetro obligatorio no es válido. Por ejemplo, en algunas versiones podría recibir este error si el tamaño especificado en la entrada es mayor que cero pero menor que el tamaño necesario.
PDH_MEMORY_ALLOCATION_FAILURE	No se puede asignar memoria para completar la función.
PDH_CSTATUS_NO_MACHINE	El equipo especificado está sin conexión o no está disponible.
PDH_CSTATUS_NO_COUNTERNAME	No se puede leer ni encontrar el nombre del contador predeterminado.
PDH_CSTATUS_NO_OBJECT	No se encontró el objeto especificado.
PDH_CSTATUS_NO_COUNTER	El objeto no especificó un contador predeterminado.

Observaciones

Debe llamar a esta función dos veces, la primera vez que obtenga el tamaño de búfer necesario (establezca szDefaultCounterName en NULL y pcchBufferSize en 0) y la segunda vez para obtener los datos.

Nota

El encabezado pdh.h define PdhGetDefaultPerfCounter como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows Server 2003 [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	pdh.h
biblioteca de	Pdh.lib
DLL de	Pdh.dll

Consulte también

PdhGetDefaultPerfCounterH

PdhGetDefaultPerfObject