Metodo IWDFDeviceInitialize::RetrieveDeviceInstanceId (wudfddi.h)

Articolo
03/05/2024

[Avviso: UMDF 2 è la versione più recente di UMDF e sostituisce UMDF 1. Tutti i nuovi driver UMDF devono essere scritti usando UMDF 2. Nessuna nuova funzionalità viene aggiunta a UMDF 1 ed è disponibile un supporto limitato per UMDF 1 nelle versioni più recenti di Windows 10. I driver di Windows universali devono usare UMDF 2. Per altre informazioni, vedere Introduzione con UMDF.]

Il metodo RetrieveDeviceInstanceId recupera l'identificatore di un'istanza di un dispositivo.

Sintassi

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

Parametri

[out, optional] Buffer

Puntatore a un buffer che riceve una stringa con terminazione NULL che rappresenta l'identificatore di un'istanza di un dispositivo se il buffer fornito non è NULL e RetrieveDeviceInstanceId ha esito positivo.

[in, out] pdwSizeInChars

Puntatore a una variabile che riceve il numero di caratteri, incluso il carattere NULL , nella stringa a cui punta Buffer .

Se Buffer è NULL, il valore fornito dal driver è zero. Il framework restituisce quindi le dimensioni, in caratteri, necessarie per la stringa di identificatore.

Se buffer non è NULL, il framework restituisce le dimensioni, in caratteri, della stringa di identificatore.

Valore restituito

RetrieveDeviceInstanceId restituisce S_OK per gli scenari seguenti:

Il buffer a cui puntava il parametro Buffer era diverso da NULL e abbastanza grande per contenere la stringa di identificatore, incluso il carattere NULL e il framework copiava correttamente la stringa nel buffer fornito e imposta la variabile a cui puntava il parametro pdwSizeInChars sul numero di caratteri nella stringa.
Il buffer in Buffer è null, il driver imposta la variabile in pdwSizeInChars su 0 e il framework imposta la variabile in pdwSizeInChars sul numero di caratteri necessari per la stringa.

RetrieveDeviceInstanceId restituisce HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) per indicare che il buffer fornito non è NULL e non contiene spazio sufficiente per contenere la stringa di identificatore. Il framework imposta la variabile in pdwSizeInChars sul numero di caratteri necessari per la stringa.

RetrieveDeviceInstanceId potrebbe restituire anche altri valori HRESULT.

Requisiti

Requisito	Valore
Fine del supporto	Non disponibile in UMDF 2.0 e versioni successive.
Piattaforma di destinazione	Desktop
Versione UMDF minima	1.5
Intestazione	wudfddi.h (include Wudfddi.h)
DLL	WUDFx.dll

Vedi anche

IWDFDeviceInitialize

Condividi tramite