パラメータ
lpLocalPath
[入力]ネットワーク資源のドライブベースのパスを表す、NULL で終わる文字列へのポインタを指定する。
たとえば、ネットワーク共有ドライブとしてドライブ H が割り当てられている場合、その共有ドライブの
\WIN32\EXAMPLES ディレクトリ内の
SAMPLE.DOC ファイルの汎用名を取得するには、ドライブベースのパスとして H:\WIN32\EXAMPLES\SAMPLE.DOC
を指定する。
dwInfoLevel
[入力]lpBuffer パラメータが指すバッファで受け取る構造体の種類を指定する。次のいずれかの値を指定する。
値
|
意味
|
UNIVERSAL_NAME_INFO_LEVEL |
この関数は、UNIVERSAL_NAME_INFO 構造体をバッファに格納する。 |
REMOTE_NAME_INFO_LEVEL |
この関数は、REMOTE_NAME_INFO 構造体をバッファに格納する。 |
UNIVERSAL_NAME_INFO
|
構造体は、UNC(Universal Naming Convention;汎用名前付け規則)名の文字列へのポ
インタを保持する。
|
REMOTE_NAME_INFO |
構造体は、UNC 名の文字列と、2 つの追加の接続情報文字列へのポインタを保持する。 |
lpBuffer
[出力]dwInfoLevel パラメータで指定した構造体を受け取るバッファへのポインタを指定する。
lpBufferSize
[入出力]lpBuffer が指すバッファのサイズ( バイト数)を保持する変数へのポインタを指定する。
関数が成功すると、lpBufferSize が指す変数は、バッファに格納された構造体のサイズ(
バイト数)を保持する。バッファが小さすぎて関
数が失敗した場合、この変数は必要なバッファのサイズを保持し、戻り値は ERROR_MORE_DATA になる。
戻り値
関数が成功すると、NO_ERROR が返る。
関数が失敗すると、次のいずれかのエラーコードが返る。
値
|
意味
|
ERROR_BAD_DEVICE |
lpLocalPath パラメータが指す文字列が無効である。 |
ERROR_CONNECTION_UNAVAIL
|
指定したリモートデバイスに現在接続されていないが、そのデバイスに対する記憶された( 恒久的
な)接続がある。
|
ERROR_EXTENDED_ERROR
|
ネットワーク固有のエラーが発生した。エラーの説明を取得するには、WNetGetLastError 関数を
使う。
|
ERROR_MORE_DATA
|
lpBuffer パラメータが指すバッファが小さすぎる。lpBufferSize パラメータが指す変数に、必要なバ
ッファサイズが格納される。この関数によって取得できるエントリが残っている。
|
ERROR_NOT_SUPPORTED
|
dwInfoLevel パラメータが UNIVERSAL_NAME_INFO_LEVEL に設定されているが、ネットワー
クプロバイダが UNC 名をサポートしていない。( どのネットワークプロバイダもこの関数をサポートし
ていない。)
|
ERROR_NO_NET_OR_BAD_PATH
|
指定したローカル名を使った接続を認識するプロバイダがない。その接続を使ういずれかのプロバイ
ダのネットワークに接続されていない可能性もある。 |
ERROR_NO_NETWORK |
ネットワークに接続されていない。 |
ERROR_NOT_CONNECTED |
lpLocalPath パラメータで指定したデバイスはリダイレクトされていない。 |
|