ホーム › NetworkManagement.WNet › NPGetResourceInformation

NPGetResourceInformation

関数

ネットワークリソースの情報をプロバイダーから取得する。

DLLdavclnt.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// davclnt.dll
#include <windows.h>

DWORD NPGetResourceInformation(
    NETRESOURCEW* lpNetResource,
    void* lpBuffer,
    DWORD* lpBufferSize,
    LPWSTR* lplpSystem
);

パラメーター

名前	型	方向	説明
lpNetResource	NETRESOURCEW*	in	情報を取得する対象のネットワークリソースを指定します。lpRemoteName フィールドには、リソースのリモート名を指定します。呼び出し元プログラムは、lpProvider フィールドと dwType フィールドの値が分かっている場合はその値を設定します。分からない場合は、これらのフィールドを NULL に設定します。NETRESOURCE のその他のフィールドはすべて無視され、初期化もされません。 lpRemoteName 文字列に、WNet API を通じてアクセスされる部分と、リソースの種類に固有の他のシステム API を通じてアクセスされる部分の両方が含まれている場合、この関数はリソースのネットワーク部分についてのみ情報を返す必要があります (本トピックで後述する lplpSystem を除きます)。たとえば、リソースが "\server\share\dir1\dir2" であり、"\server\share" が WNet API を通じて、"\dir1\dir2" がファイルシステム API を通じてアクセスされる場合、プロバイダーは自身が "\server\share" に対する正しいプロバイダーであることを確認する必要がありますが、"\dir1\dir2" が実際に存在するかどうかを確認する必要はありません。
lpBuffer	void*	out	結果を受け取るバッファーへのポインター。結果の先頭フィールドは、入力リソースのうち、リソースの種類に固有のシステム API ではなく WNet API を通じてアクセスされる部分を表す単一の NETRESOURCE 構造体と、それに関連する文字列です。たとえば、入力のリモートリソース名が "\server\share\dir1\dir2" であった場合、出力される NETRESOURCE にはリソース "\server\share" に関する情報が格納されます。値が設定されて返されるのは lpRemoteName、lpProvider、dwType、dwDisplayType、dwUsage の各フィールドで、その他のフィールドはすべて NULL に設定されます。 lpRemoteName フィールドは、 NPEnumResource 関数による列挙で返されるものと同じ形式で返す必要があります。これにより、呼び出し元は大文字と小文字を区別した文字列比較を実行できます。これは、出力されたネットワークリソースが NPEnumResource によって返されたものと同一かどうかを判断するために必要です。プロバイダーは、自身がそのリソースを所有しているかどうかを判断するために、純粋に構文上のチェックだけを行ってはなりません。クライアント上で 2 つのネットワークが動作しており、構文上のチェックのみを行うプロバイダーが先に呼び出された場合、誤った結果になる可能性があります。
lpBufferSize	DWORD*	inout	lpBuffer が指すバッファーのサイズ (バイト単位) を指定する場所へのポインター。バッファーが結果を格納するには小さすぎる場合、この関数はこの場所に必要なバッファーサイズを格納し、エラー WN_MORE_DATA を返します。
lplpSystem	LPWSTR*	out	正常に復帰した場合、出力バッファー内の null で終わる文字列へのポインターです。この文字列は、リソースのうち WNet API ではなく、リソースの種類に固有のシステム API を通じてアクセスされる部分を示します。そのような部分が存在しない場合、lplpSystem は NULL に設定されます。たとえば、入力のリモートリソース名が "\server\share\dir" であった場合、lpRemoteName は "\server\share" を指して返され、lplpSystem は "\dir" を指します。どちらの文字列も lpBuffer が指すバッファーに格納されます。

戻り値の型: DWORD

公式ドキュメント

ネットワークリソースのうち、WNet API を通じてアクセスされる部分と、リソースの種類に固有の API を通じてアクセスされる部分とを分離します。

戻り値

関数が成功した場合は、WN_SUCCESS を返す必要があります。それ以外の場合はエラーコードを返す必要があり、次のいずれかになります。

戻り値	説明
WN_MORE_DATA	入力バッファーが小さすぎます。
WN_BAD_NETNAME	このプロバイダーはそのリソースを認識しません。
WN_BAD_VALUE	dwUsage または dwType が無効です。
WN_BAD_DEV_TYPE	呼び出し元が渡した 0 以外の dwType が、ネットワークリソースの実際の種類と一致しません。
WN_NOT_AUTHENTICATED	呼び出し元がネットワークに対して認証されていません。
WN_ACCESS_DENIED	呼び出し元はネットワークに対して認証されていますが、十分なアクセス許可がありません。

解説(Remarks)

列挙ツリーは、 NPOpenEnum とその関連関数を使用して、名前付きのネットワークリソースから下方向にたどることができます。名前付きリソースから上方向にたどるには、NPGetResourceInformation 関数を呼び出してそのリソースに関する情報を取得し、続いて NPGetResourceParent 関数を呼び出して親リソースの名前と種類を取得します。

NPGetResourceInformation は、指定されたプロバイダーが、指定されたネットワークリソースに対する要求に応答すべき適切なプロバイダーであるかどうかを判断します。その後、そのリソースの種類に関する情報を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// davclnt.dll
#include <windows.h>

DWORD NPGetResourceInformation(
    NETRESOURCEW* lpNetResource,
    void* lpBuffer,
    DWORD* lpBufferSize,
    LPWSTR* lplpSystem
);

[DllImport("davclnt.dll", ExactSpelling = true)]
static extern uint NPGetResourceInformation(
    IntPtr lpNetResource,   // NETRESOURCEW*
    IntPtr lpBuffer,   // void* out
    ref uint lpBufferSize,   // DWORD* in/out
    IntPtr lplpSystem   // LPWSTR* out
);

<DllImport("davclnt.dll", ExactSpelling:=True)>
Public Shared Function NPGetResourceInformation(
    lpNetResource As IntPtr,   ' NETRESOURCEW*
    lpBuffer As IntPtr,   ' void* out
    ByRef lpBufferSize As UInteger,   ' DWORD* in/out
    lplpSystem As IntPtr   ' LPWSTR* out
) As UInteger
End Function

' lpNetResource : NETRESOURCEW*
' lpBuffer : void* out
' lpBufferSize : DWORD* in/out
' lplpSystem : LPWSTR* out
Declare PtrSafe Function NPGetResourceInformation Lib "davclnt" ( _
    ByVal lpNetResource As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpBufferSize As Long, _
    ByVal lplpSystem As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NPGetResourceInformation = ctypes.windll.davclnt.NPGetResourceInformation
NPGetResourceInformation.restype = wintypes.DWORD
NPGetResourceInformation.argtypes = [
    ctypes.c_void_p,  # lpNetResource : NETRESOURCEW*
    ctypes.POINTER(None),  # lpBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # lpBufferSize : DWORD* in/out
    ctypes.c_void_p,  # lplpSystem : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('davclnt.dll')
NPGetResourceInformation = Fiddle::Function.new(
  lib['NPGetResourceInformation'],
  [
    Fiddle::TYPE_VOIDP,  # lpNetResource : NETRESOURCEW*
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    Fiddle::TYPE_VOIDP,  # lpBufferSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lplpSystem : LPWSTR* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "davclnt")]
extern "system" {
    fn NPGetResourceInformation(
        lpNetResource: *mut NETRESOURCEW,  // NETRESOURCEW*
        lpBuffer: *mut (),  // void* out
        lpBufferSize: *mut u32,  // DWORD* in/out
        lplpSystem: *mut *mut u16  // LPWSTR* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("davclnt.dll")]
public static extern uint NPGetResourceInformation(IntPtr lpNetResource, IntPtr lpBuffer, ref uint lpBufferSize, IntPtr lplpSystem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'davclnt_NPGetResourceInformation' -Namespace Win32 -PassThru
# $api::NPGetResourceInformation(lpNetResource, lpBuffer, lpBufferSize, lplpSystem)

#uselib "davclnt.dll"
#func global NPGetResourceInformation "NPGetResourceInformation" sptr, sptr, sptr, sptr
; NPGetResourceInformation varptr(lpNetResource), lpBuffer, varptr(lpBufferSize), varptr(lplpSystem)   ; 戻り値は stat
; lpNetResource : NETRESOURCEW* -> "sptr"
; lpBuffer : void* out -> "sptr"
; lpBufferSize : DWORD* in/out -> "sptr"
; lplpSystem : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "davclnt.dll"
#cfunc global NPGetResourceInformation "NPGetResourceInformation" var, sptr, var, var
; res = NPGetResourceInformation(lpNetResource, lpBuffer, lpBufferSize, lplpSystem)
; lpNetResource : NETRESOURCEW* -> "var"
; lpBuffer : void* out -> "sptr"
; lpBufferSize : DWORD* in/out -> "var"
; lplpSystem : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "davclnt.dll"
#cfunc global NPGetResourceInformation "NPGetResourceInformation" sptr, sptr, sptr, sptr
; res = NPGetResourceInformation(varptr(lpNetResource), lpBuffer, varptr(lpBufferSize), varptr(lplpSystem))
; lpNetResource : NETRESOURCEW* -> "sptr"
; lpBuffer : void* out -> "sptr"
; lpBufferSize : DWORD* in/out -> "sptr"
; lplpSystem : LPWSTR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。