Microsoft DirectX 8.0 (C++)

IDirectPlay8Address::AddComponent

アドレスにコンポーネントを追加する。コンポーネントがアドレスの一部である場合、この呼び出しにより新しい値に置き換わる。

この呼び出しを行うと、値はネイティブなフォーマットで指定される。したがって、lpvData パラメータは、ネイティブ フォーマットでデータを保持する変数に再設定されたポインタにする必要がある。たとえば、コンポーネントが GUID である場合、lpvData パラメータには GUID に再設定されたポインタを指定する必要がある。

このメソッドは、定義済みコンポーネント タイプが正しいフォーマットであるかどうかを確認する。

HRESULT AddComponent(
const WCHAR *const pwszName,
const void *const lpvData,
const DWORD dwDataSize,
const DWORD dwDataType 
);

パラメータ

pwszName
コンポーネントのキーを保持する、NULL で終わる Unicode 文字列。
lpvData
指定されたキーに関連付けられた値を保持するバッファへのポインタ。データはネイティブ フォーマットで指定する必要がある。
dwDataSize
lpvData に保持されるバッファのデータ サイズ (バイト単位)。サイズはデータ型によって異なる。サイズが正しく指定されていない場合、このメソッドは DPNERR_INVALIDPARAM を返す。
DWORD
サイズ = sizeof( DWORD )
GUID
サイズ = sizeof( GUID )
String
サイズ = NULL ターミネータを含む文字列のサイズ (バイト単位)。
dwDataType
このキーに関連付けられた値のデータ型。データ型は、次のいずれかを使用できる。
DPNA_DATATYPE_STRING
データは NULL 終端文字列である。
DPNA_DATATYPE_DWORD
データは DWORD である。
DPNA_DATATYPE_GUID
データは GUID である。
DPNA_DATATYPE_BINARY
データは未処理のバイナリ フォーマットである。

戻り値

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

DPNERR_INVALIDPARAM
DPNERR_INVALIDPOINTER
DPNERR_NOTALLOWED

動作環境

  Windows NT/2000 : Windows 2000 以降に対する再配布可能ファイルとして提供。
  Windows 95/98 : Windows 95 以降に対する再配布可能ファイルとして提供。
  ヘッダー : Dpaddr.h で宣言。