IDirectPlay8LobbyClient::GetConnectionSettings メソッド
IDirectPlay8LobbyClient::GetConnectionSettings メソッド
指定された接続の接続設定セットを取得する。これらの設定は、IDirectPlay8LobbyClient::ConnectApplication、IDirectPlay8LobbyClient::SetConnectionSettings、または IDirectPlay8LobbiedApplication::SetConnectionSettings のいずれかのメソッドの呼び出しによって設定できる。
接続設定を取得すると、ユーザーに返される各アドレス オブジェクトに参照が追加される。したがって、構造体の処理が終了したら、ユーザーは各アドレス オブジェクトに対して Release を呼び出す必要がある。
構文
HRESULT GetConnectionSettings(
const DPNHANDLE hConnection,
DPL_CONNECTION_SETTINGS *const pdplConnectSettings,
DWORD *pdwDataSize,
const DWORD dwFlags
);
パラメータ
- hConnection
[in] 設定を取得する接続へのハンドル。 - pdplConnectSettings
[out] 指定された接続の接続設定を受け取るバッファへのポインタ。 - pdwDataSize
[in, out] pdplConnectSettings 構造体に指定されたバッファのサイズ (バイト単位) を保持する DWORD へのポインタ。バッファが接続設定を保持できるだけの大きさではない場合、DPNERR_BUFFERTOOSMALL が返され、この値には必要なバッファ サイズが設定される。成功した場合、この値は、指定されたバッファに書き込まれたバイト数を保持する。 - dwFlags
[in] 将来の使用に備えて予約されているので、0 に設定しておく。
戻り値
成功した場合は S_OK を返し、失敗した場合は次のいずれかのエラー値を返す。
| DPNERR_INVALIDPARAM | メソッドに渡された 1 つ以上のパラメータが無効である。 |
| DPNERR_BUFFERTOOSMALL | 指定されたバッファが小さすぎて、要求されたデータを格納できない。 |
| DPNERR_INVALIDOBJECT | Microsoft® DirectPlay® オブジェクトのポインタは無効である。 |
| DPNERR_INVALIDFLAGS | このメソッドに渡されたフラグは無効である。 |