Condividi tramite

Metodo IWMDMDevice2::GetCanonicalName (mswmdm.h)

  • Articolo

Il metodo GetCanonicalName recupera il nome canonico del dispositivo.

Sintassi

HRESULT GetCanonicalName(
  [out] LPWSTR pwszPnPName,
  [in]  UINT   nMaxChars
);

Parametri

[out] pwszPnPName

Buffer di caratteri wide per i nomi canonici. Questo buffer deve essere allocato e rilasciato dal chiamante.

[in] nMaxChars

Intero che specifica il numero massimo di caratteri che è possibile inserire in pwszPnPName, incluso il carattere di terminazione.

Valore restituito

Il metodo restituisce un valore HRESULT. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente.

Codice restituito Descrizione
E_INVALIDARG
 Il parametro pwszPnPName è un puntatore NULL o non valido.
WMDM_E_NOTSUPPORTED
 Il dispositivo non supporta un nome canonico.
WMDM_E_BUFFERTOOSMALL
 Il buffer specificato è troppo piccolo per il nome canonico.
E_FAIL
 Si è verificato un errore non specificato.

Commenti

L'applicazione può usare il nome canonico recuperato per chiamare IWMDeviceManager2::GetDeviceFromCanonicalName per trovare di nuovo il dispositivo.

Il nome canonico restituito è nel formato <PnP Device Path>$<index, dove index> è un indice in base zero negli oggetti dispositivo restituiti dal provider di servizi per il percorso del dispositivo PnP specificato.

Il formato del nome canonico è soggetto a modifiche nelle versioni future di Windows Media Gestione dispositivi.

Esempio

Il codice C++ seguente recupera un nome canonico del dispositivo.


// Obtain an IWMDMDevice2 interface and call
// some methods.
const UINT MAX_CHARS = 100;
CComQIPtr<IWMDMDevice2> pIWMDMDevice2(pIWMDMDevice);
if (pIWMDMDevice2 != NULL)
{
    // Get the canonical name.
    WCHAR canonicalName[MAX_CHARS];
    hr = pIWMDMDevice2->GetCanonicalName(canonicalName, MAX_CHARS);
    if (hr == S_OK)
    {
        // TODO: Retrieve the canonical name.
    }

    // Find out the driver.
    myGetDriverName(pIWMDMDevice2);
}

Requisiti

Requisito Valore
Piattaforma di destinazione Windows
Intestazione mswmdm.h
Libreria Mssachlp.lib

Vedi anche

Interfaccia IWMDMDevice2

IWMDeviceManager2::GetDeviceFromCanonicalName