Compartir a través de


Método IWDFDevice::RetrieveDeviceInstanceId (wudfddi.h)

[Advertencia: UMDF 2 es la versión más reciente de UMDF y sustituye a UMDF 1. Todos los nuevos controladores UMDF deben escribirse mediante UMDF 2. No se agregan nuevas características a UMDF 1 y hay compatibilidad limitada con UMDF 1 en versiones más recientes de Windows 10. Los controladores universales de Windows deben usar UMDF 2. Para obtener más información, consulta Introducción a UMDF.]

El método RetrieveDeviceInstanceId recupera el identificador de una instancia de un dispositivo.

Sintaxis

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

Parámetros

[out, optional] Buffer

Puntero a un búfer que recibe una NULL terminada que representa el identificador de una instancia del dispositivo, si el búfer proporcionado no es NULL y RetrieveDeviceInstanceId se realiza correctamente.

[in, out] pdwSizeInChars

Puntero a una variable que recibe el número de caracteres, incluido el carácter de NULL, en la cadena a la que buffer apunta.

Si de búfer es NULL, el valor proporcionado por el controlador es cero. A continuación, el marco devuelve el tamaño, en caracteres, que son necesarios para la cadena de identificador.

Si de búfer no esNULL, el marco devuelve el tamaño, en caracteres, de la cadena de identificador.

Valor devuelto

retrieveDeviceInstanceId devuelve S_OK para los escenarios siguientes:

  • El búfer al que apunta el parámetro buffer no eraNULL y lo suficientemente grande como para contener la cadena de identificador, incluido el carácter NULL y el marco copió correctamente la cadena en el búfer proporcionado y estableció la variable a la que apunta el parámetro pdwSizeInChars al número de caracteres de la cadena.
  • El búfer de buffer se NULL, el controlador preestablece la variable en pdwSizeInChars en 0 y el marco establece la variable en pdwSizeInChars al número de caracteres necesarios para la cadena.
RetrieveDeviceInstanceId devuelve HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para indicar que el búfer proporcionado no era NULL y no contenía suficiente espacio para contener la cadena de identificador. El marco establece la variable en pdwSizeInChars en el número de caracteres necesarios para la cadena.

RetrieveDeviceInstanceId también puede devolver otros valores HRESULT.

Requisitos

Requisito Valor
fin del soporte técnico No disponible en UMDF 2.0 y versiones posteriores.
de la plataforma de destino de Escritorio
versión mínima de UMDF 1.5
encabezado de wudfddi.h (incluya Wudfddi.h)
DLL de WUDFx.dll

Consulte también

IWDFDevice