Función PdhAddCounterA (pdh.h)

Artículo
03/01/2024

Agrega el contador especificado a la consulta.

Sintaxis

PDH_FUNCTION PdhAddCounterA(
  [in]  PDH_HQUERY   hQuery,
  [in]  LPCSTR       szFullCounterPath,
  [in]  DWORD_PTR    dwUserData,
  [out] PDH_HCOUNTER *phCounter
);

Parámetros

[in] hQuery

Identificador de la consulta a la que desea agregar el contador. La función PdhOpenQuery devuelve este identificador.

[in] szFullCounterPath

Cadena terminada en NULL que contiene la ruta de acceso del contador. Para obtener más información sobre el formato de una ruta de acceso de contador, vea Especificar una ruta de acceso de contador. La longitud máxima de una ruta de acceso de contador es PDH_MAX_COUNTER_PATH.

[in] dwUserData

Valor definido por el usuario. Este valor se convierte en parte de la información del contador. Para recuperar este valor más adelante, llame a la función PdhGetCounterInfo y acceda al miembro dwUserData de la estructura PDH_COUNTER_INFO .

[out] phCounter

Identificador del contador que se agregó a la consulta. Es posible que tenga que hacer referencia a este identificador en llamadas posteriores.

Valor devuelto

Devuelve ERROR_SUCCESS si la función se realiza correctamente.

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_CSTATUS_BAD_COUNTERNAME	No se pudo analizar ni interpretar la ruta de acceso del contador.
PDH_CSTATUS_NO_COUNTER	No se puede encontrar el contador especificado en el equipo o en el archivo de registro.
PDH_CSTATUS_NO_COUNTERNAME	La ruta de acceso del contador está vacía.
PDH_CSTATUS_NO_MACHINE	La ruta de acceso no contenía un nombre de equipo y la función no pudo recuperar el nombre del equipo local.
PDH_CSTATUS_NO_OBJECT	No se puede encontrar el objeto especificado en el equipo o en el archivo de registro.
PDH_FUNCTION_NOT_FOUND	No se puede determinar la función de cálculo que se va a usar para este contador.
PDH_INVALID_ARGUMENT	Uno o varios argumentos no son válidos.
PDH_INVALID_HANDLE	El identificador de consulta no es válido.
PDH_MEMORY_ALLOCATION_FAILURE	No se puede asignar la memoria necesaria para completar la función.

Comentarios

Si la ruta de acceso del contador contiene un carácter comodín, todos los nombres de contador que coincidan con el carácter comodín se agregan a la consulta.

Si se especifica una instancia de contador que aún no existe, PdhAddCounter no notifica una condición de error. En su lugar, devuelve ERROR_SUCCESS. El motivo de este comportamiento es que no se sabe si se ha especificado una instancia de contador inexistente o si existe, pero aún no se ha creado.

Para quitar el contador de la consulta, use la función PdhRemoveCounter .

Ejemplos

Para obtener un ejemplo, vea Examinar contadores de rendimiento o Leer datos de rendimiento de un archivo de registro.

Nota

El encabezado pdh.h define PdhAddCounter 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 Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	pdh.h
Library	Pdh.lib
Archivo DLL	Pdh.dll