IDirectPlay8Peer::GetSendQueueInfo メソッド
IDirectPlay8Peer::GetSendQueueInfo メソッド
アプリケーションで送信キューのサイズを監視するために使う。
構文
HRESULT GetSendQueueInfo(
const DPNID dpnid,
DWORD *const pdwNumMsgs,
DWORD *const pdwNumBytes,
const DWORD dwFlags
);
パラメータ
- dpnid
[in] 送信キュー情報を取得するプレーヤの DPNID。 - pdwNumMsgs
[out] 現在キューに蓄積されているメッセージの数を保持する DWORD 型の変数へのポインタ。この値はオプションであり、NULL に設定できる。 - pdwNumBytes
[out] 現在キューに蓄積されているメッセージ データの総バイト数を指定する DWORD 型の変数へのポインタ。この値はオプションであり、NULL に設定できる。 - dwFlags
[in] DPNGETSENDQUEUEINFO_PRIORITY_NORMAL、DPNGETSENDQUEUEINFO_PRIORITY_HIGH、または DPNGETSENDQUEUEINFO_PRIORITY_LOW フラグを指定して、その優先順位を持つ特定のメッセージについて問い合わせることができる。
戻り値
成功した場合は、S_OK を返す。それ以外の場合は、次のいずれかのエラー値を返す。
DPNERR_INVALIDPARAM | メソッドに渡された 1 つ以上のパラメータが無効である。 |
注意
Microsoft® DirectPlay® は受信側コンピュータが処理できる以上の速度でメッセージを送信しない。そのため、送信元のコンピュータが、送信先が受け取れる速さよりも高速にメッセージを送信した場合、メッセージは送信側のキューに蓄積される。アプリケーションにより、送信キューのサイズが大きすぎると登録された場合は、メッセージの送信レートを低下させる必要がある。
pdwNumMsgs と pdwNumBytes の両方を NULL に設定することはできない。少なくともいずれか 1 つは有効なポインタに設定する必要がある。