Metodo IDebugRegisters2::GetDescription (dbgeng.h)

  • Articolo

Il metodo GetDescription restituisce la descrizione di un registro.

Sintassi

HRESULT GetDescription(
  [in]            ULONG                       Register,
  [out, optional] PSTR                        NameBuffer,
  [in]            ULONG                       NameBufferSize,
  [out, optional] PULONG                      NameSize,
  [out, optional] PDEBUG_REGISTER_DESCRIPTION Desc
);

Parametri

[in] Register

Specifica l'indice del registro per il quale viene richiesta la descrizione.

[out, optional] NameBuffer

Specifica il buffer in cui archiviare il nome del registro. Se NameBuffer è NULL, queste informazioni non vengono restituite.

[in] NameBufferSize

Specifica le dimensioni, in caratteri, del buffer specificato da NameBuffer . Questa dimensione include lo spazio per il carattere di terminazione '\0'.

[out, optional] NameSize

Riceve le dimensioni, in caratteri, del nome del registro nel buffer NameBuffer . Questa dimensione include lo spazio per il carattere di terminazione '\0'. Se NameSize è NULL, queste informazioni non vengono restituite.

[out, optional] Desc

Riceve la descrizione del registro. Per altre informazioni, vedere DEBUG_REGISTER_DESCRIPTION .

Valore restituito

Questo elenco non contiene tutti gli errori che potrebbero verificarsi. Per un elenco degli errori possibili, vedere Valori HRESULT.

Codice restituito Descrizione
S_OK
 Il metodo è stato eseguito correttamente.
S_FALSE
 Il metodo è stato eseguito correttamente. Tuttavia, il buffer non era abbastanza grande per contenere il nome del registro, quindi è stato troncato.
E_UNEXPECTED
 Non è stato specificato alcun computer di destinazione o non è stata trovata una descrizione del registro.
E_INVALIDARG
 L'indice del registro richiesto è maggiore del numero totale di registri nel computer di destinazione.

Commenti

Per una panoramica dell'interfaccia IDebugRegisters e di altri metodi correlati al registro, vedere Registri.

Requisiti

Requisito Valore
Piattaforma di destinazione Desktop
Intestazione dbgeng.h (include DbgEng.h)