Share via

IDirectPlay8Address::AddComponent メソッド

  • [アーティクル]

IDirectPlay8Address::AddComponent メソッド

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

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

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

構文

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

パラメータ

  • pwszName
    [in] コンポーネントのキーを保持する NULL で終わる Unicode 文字列。有効な文字列に設定するか、次の定義済みの値を使える。

    • DPNA_KEY_APPLICATION_INSTANCE

    • DPNA_KEY_BAUD

    • DPNA_KEY_DEVICE

    • DPNA_KEY_FLOWCONTROL

    • DPNA_KEY_HOSTNAME

    • DPNA_KEY_NAMEINFO

    • DPNA_KEY_NAT_RESOLVER

    • DPNA_KEY_NAT_RESOLVER_USER_STRING

    • DPNA_KEY_PARITY

    • DPNA_KEY_PHONENUMBER

    • DPNA_KEY_PORT

    • DPNA_KEY_PROCESSOR

    • DPNA_KEY_PROGRAM

    • DPNA_KEY_PROVIDER

    • DPNA_KEY_SCOPE

    • DPNA_KEY_STOPBITS

    • DPNA_KEY_TRAVERSALMODE

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

戻り値

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

DPNERR_INVALIDPARAM メソッドに渡された 1 つ以上のパラメータが無効である。
DPNERR_INVALIDPOINTER パラメータとして指定されたポインタが無効である。
DPNERR_NOTALLOWED この機能は、このオブジェクトでは許可されていない。

注意

さまざまなアドレス コンポーネントとそのキーの詳細については、「データ値」を参照すること。