Función PdhGetDefaultPerfObjectHA (pdh.h)

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

Esta función es idéntica a la función PdhGetDefaultPerfObject, salvo que admite el uso de identificadores para orígenes de datos.

Sintaxis

PDH_FUNCTION PdhGetDefaultPerfObjectHA(
  [in]      PDH_HLOG hDataSource,
  [in]      LPCSTR   szMachineName,
  [out]     LPSTR    szDefaultObjectName,
  [in, out] LPDWORD  pcchBufferSize
);

Parámetros

[in] hDataSource

Debe ser null.

Si especifica un identificador de archivo de registro, szDefaultObjectName será una cadena de null 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.

[out] szDefaultObjectName

Búfer asignado por el autor de la llamada que recibe el nullnombre de objeto predeterminado terminado. Establézcalo en NULL si pcchBufferSize es cero.

Tenga en cuenta que PDH siempre devuelve Processor para el nombre de objeto predeterminado.

[in, out] pcchBufferSize

Tamaño del búfer de szDefaultObjectName, 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 szDefaultObjectName buffer es demasiado pequeño para contener el nombre del objeto. 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 de objeto predeterminado.

Observaciones

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

Nota

El encabezado pdh.h define PdhGetDefaultPerfObjectH 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

PdhBindInputDataSource

PdhBrowseCountersH

PdhGetDefaultPerfCounterH