IDebugRegisters2::GetDescription メソッド (dbgeng.h)
GetDescription メソッドはレジスタの説明を返します。
構文
HRESULT GetDescription(
[in] ULONG Register,
[out, optional] PSTR NameBuffer,
[in] ULONG NameBufferSize,
[out, optional] PULONG NameSize,
[out, optional] PDEBUG_REGISTER_DESCRIPTION Desc
);
パラメーター
[in] Register
説明が要求されるレジスタのインデックスを指定します。
[out, optional] NameBuffer
レジスタの名前を格納するバッファーを指定します。 NameBuffer が NULL の場合、この情報は返されません。
[in] NameBufferSize
NameBuffer が指定するバッファーのサイズを文字数で指定します。 このサイズには、'\0' 終端文字のスペースが含まれます。
[out, optional] NameSize
NameBuffer バッファー内のレジスタの名前のサイズを文字数で受け取ります。 このサイズには、'\0' 終端文字のスペースが含まれます。 NameSize が NULL の場合、この情報は返されません。
[out, optional] Desc
レジスタの説明を受け取ります。 詳細については、「 DEBUG_REGISTER_DESCRIPTION 」を参照してください。
戻り値
この一覧には、発生する可能性のあるすべてのエラーが含まれているわけではありません。 考えられるエラーの一覧については、「 HRESULT 値」を参照してください。
リターン コード | 説明 |
---|---|
|
メソッドは正常に実行されました。 |
|
メソッドは正常に実行されました。 ただし、バッファーはレジスタの名前を保持するのに十分な大きさではないため、切り捨てられました。 |
|
ターゲット コンピューターが指定されていないか、レジスタの説明が見つかりませんでした。 |
|
要求されたレジスタのインデックスが、ターゲットのマシン上のレジスタの合計数を超えています。 |
注釈
IDebugRegisters インターフェイスとその他のレジスタ関連のメソッドの概要については、「Registers」を参照してください。
要件
要件 | 値 |
---|---|
対象プラットフォーム | デスクトップ |
Header | dbgeng.h (DbgEng.h を含む) |