IDirectPlay8Address::GetComponentByName メソッド

IDirectPlay8Address::GetComponentByName メソッド

指定されたキーのコンポーネントに関する情報を取得する。コンポーネントの値はネイティブなフォーマットで取得される。コンポーネント キーが見つからない場合、DPNERR_DOESNOTEXIST が返される。

コンポーネントの値はネイティブなフォーマットで取得される。したがって、コンポーネントの値が DWORD である場合、この呼び出しにより DWORD が取得される。つまり、バッファ サイズは 4 であり、pvBuffer は PDWORD に再設定される。

構文

HRESULT GetComponentByName(      
    const WCHAR *const pwszName,
    void *pvBuffer,
    PDWORD pdwBufferSize,
    PDWORD pdwDataType
);

パラメータ

• pwszName
  [in] 取得するコンポーネントの名前を指定する文字列。
• pvBuffer
  [out] コンポーネントの値に格納されるデータを取得するバッファ。必要なサイズを取得するには、このパラメータに NULL を指定し、pdwBufferSize が指す DWORD に 0 を指定する。この場合、メソッドは DPNERR_BUFFERTOOSMALL を返す。
• pdwBufferSize
  [in, out] 入力では、pvBuffer が指す、バッファのサイズ (バイト単位) を保持する DWORD へのポインタ。出力では、成功の場合はバッファに書き込まれたバイト数、失敗の場合はデータの格納に必要なバイト数を保持する DWORD へのポインタ。
• pdwDataType
  [out] このパラメータが指す DWORD。このコンポーネントに格納されるデータ型に設定される。次のいずれかに設定できる。
  • DPNA_DATATYPE_STRING
    データは NULL 終端文字列である。
  • DPNA_DATATYPE_DWORD
    データは DWORD である。
  • DPNA_DATATYPE_GUID
    データはグローバル一意識別子 (GUID) である。
  • DPNA_DATATYPE_BINARY
    データは未処理のバイナリである。

戻り値

成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。

DPNERR_BUFFERTOOSMALL	指定されたバッファが小さすぎて、要求されたデータを格納できない。
DPNERR_DOESNOTEXIST	要求された要素はアドレスの一部ではない。
DPNERR_INVALIDPARAM	メソッドに渡された 1 つ以上のパラメータが無効である。