次の方法で共有

MultinetGetConnectionPerformanceW 関数 (winnetwk.h)

  • [アーティクル]

MultinetGetConnectionPerformance 関数は、ネットワーク リソースへのアクセスに使用される接続の予想されるパフォーマンスに関する情報を返します。

構文

DWORD MultinetGetConnectionPerformanceW(
  [in]  LPNETRESOURCEW         lpNetResource,
  [out] LPNETCONNECTINFOSTRUCT lpNetConnectInfoStruct
);

パラメーター

[in] lpNetResource

ネットワーク リソースを指定する NETRESOURCE 構造体へのポインター。 次のメンバーは、このコンテキストで特定の意味を持ちます。

メンバー 説明
lpLocalName
 クエリ対象のネットワーク リソースにリダイレクトされるローカル デバイス ("F:" や "LPT1" など) を指定するバッファーへのポインター。

このメンバーが NULL または空の文字列の場合、ネットワーク リソースは lpRemoteName メンバーで指定されます。 このフラグでローカル デバイスが指定されている場合、 lpRemoteName は無視されます。
lpRemoteName
 クエリを実行するネットワーク リソースへのポインター。 リソースには現在、接続が確立されている必要があります。 たとえば、リソースがファイル サーバー上のファイルである場合、ファイルを開くと接続が保証されます。
lpProvider
 通常は NULL に設定されますが、リソースが存在するネットワークがわかっている場合は、リソースの所有者 (プロバイダー) へのポインターを指定できます。

lpProvider メンバーが NULL でない場合、システムは名前付きネットワークに関する情報のみを返そうとします。

[out] lpNetConnectInfoStruct

データを受信する NETCONNECTINFOSTRUCT 構造体へのポインター。

戻り値

関数が成功した場合、戻り値はNO_ERROR。

関数が失敗した場合、戻り値は システム エラー コード (次のいずれかの値など) です。

リターン コード 説明
ERROR_NOT_SUPPORTED
 ネットワーク リソースはこの情報を提供しません。
ERROR_NOT_CONNECTED
 lpNetResource パラメーターが指す NETRESOURCE 構造体の lpLocalName メンバーは、リダイレクトされたデバイスを指定しないか、lpRemoteName メンバーが現在接続されているリソースの名前を指定しません。
ERROR_NO_NET_OR_BAD_PATH
 ネットワーク コンポーネントが開始されていないか、指定したリソース名が認識されないために、操作を完了できませんでした。
ERROR_BAD_DEVICE
 lpLocalName メンバーによって指定されたローカル デバイスが無効です。
ERROR_BAD_NET_NAME
 ネットワーク名が見つかりません。 このエラーは、lpNetResource パラメーターが指す NETRESOURCE 構造体の lpLocalName メンバーが NULL で、lpNetResource が指す NETRESOURCE 構造体の lpRemoteName メンバーも、または NULL であるか、ネットワークで認識できなかった場合に返されます。
ERROR_INVALID_ADDRESS
 無効なアドレスにアクセスしようとしました。 lpNetResource パラメーターまたは lpNetConnectInfoStruct パラメーターが NULL の場合、このエラーが返されます。
ERROR_INVALID_PARAMETER
 無効なパラメーターが渡されました。 lpNetConnectInfoStruct パラメーターが、cbStructure メンバーが適切な構造体サイズで埋められた NETCONNECTINFOSTRUCT 構造体を指していない場合、このエラーが返されます。
ERROR_NO_NETWORK
 ネットワークが利用できません。
ERROR_EXTENDED_ERROR
 ネットワーク固有のエラーが発生しました。 エラーの説明を取得するには、 WNetGetLastError を呼び出します。

解説

MultinetGetConnectionPerformance 関数は、NETCONNECTINFOSTRUCT 構造体の情報を返します。

MultinetGetConnectionPerformance 関数によって返される情報は見積もりのみです。 ネットワーク トラフィックとルーティングは、返される結果の精度に影響を与える可能性があります。

MultinetGetConnectionPerformance 関数は、ネットワーク リソースにリダイレクトされるローカル デバイス、または現在接続が存在するネットワーク リソースの情報を要求する場合にのみ使用できることに注意してください。

lpNetResource パラメーターが指す NETRESOURCE 構造体の lpRemoteName メンバーに UNC パスが指定されている場合、lpRemoteName メンバーはファイル名ではなくディレクトリ名である必要があります。

この関数を使用する一般的な方法は、ネットワーク サーバー上でファイルを開き (ファイルへの接続があることを保証する)、この関数を呼び出し、結果を使用してファイル I/O の管理方法を決定することです。 たとえば、ファイル全体をクライアント上の一時ファイルに読み込むか、サーバー上のファイルに直接アクセスするかを決定できます。

注意

winnetwk.h ヘッダーは、MultinetGetConnectionPerformance をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winnetwk.h
Library Mpr.lib
[DLL] Mpr.dll

関連項目

NETCONNECTINFOSTRUCT

NETRESOURCE

Windows ネットワーク (WNet) の概要

Windows ネットワーク関数