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

[Advertencia: UMDF 2 es la versión más reciente de UMDF y sustituye a UMDF 1. Todos los controladores UMDF nuevos deben escribirse con 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 con 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 cadena terminada en NULL que representa el identificador de una instancia de un 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 NULL , en la cadena a la que apunta Buffer .

Si Buffer es NULL, el valor que proporciona el controlador es cero. A continuación, el marco devuelve el tamaño, en caracteres, necesario para la cadena de identificador.

Si Buffer no es NULL, 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 era NULL 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 apuntaba el parámetro pdwSizeInChars en el número de caracteres de la cadena.
• El búfer en Buffer era NULL, el controlador preestablece la variable en pdwSizeInChars en 0 y el marco establece la variable en pdwSizeInChars en el número de caracteres necesarios para la cadena.

RetrieveDeviceInstanceId devuelve HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) para indicar que el búfer proporcionado no es NULL y no contiene 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 podría devolver otros valores HRESULT.

Requisitos

Requisito	Value
Finalización del soporte técnico	No disponible en UMDF 2.0 y versiones posteriores.
Plataforma de destino	Escritorio
Versión mínima de UMDF	1.5
Encabezado	wudfddi.h (incluya Wudfddi.h)
Archivo DLL	WUDFx.dll

Consulte también

IWDFDeviceInitialize