Win32 API 日本語リファレンス
ホーム › NetworkManagement.WNet › WNetGetResourceParentW

WNetGetResourceParentW

関数
ネットワークリソースの親リソース情報を取得する(Unicode版)。
DLLMPR.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetGetResourceParentW(
    NETRESOURCEW* lpNetResource,
    void* lpBuffer,
    DWORD* lpcbBuffer
);

パラメーター

名前型方向説明
lpNetResourceNETRESOURCEW*in

親の名前を取得する対象のネットワークリソースを指定する NETRESOURCE 構造体へのポインターです。

入力する NETRESOURCE 構造体のメンバーは、次のように指定します。通常、呼び出し元は WNetGetResourceInformation または WNetGetResourceParent の以前の呼び出しによって、lpProvider メンバーおよび dwType メンバーに指定すべき値を把握しています。

メンバー 意味
dwType
このメンバーは、値が分かっている場合に設定します。分からない場合は NULL に設定します。
lpRemoteName
このメンバーには、親を取得する対象のネットワークリソースのリモート名を指定します。
lpProvider
このメンバーには、そのリソースを所有するネットワークプロバイダーを指定します。このメンバーは必須です。指定しない場合、関数が正しくない結果を返すことがあります。

NETRESOURCE 構造体のその他のメンバーはすべて無視されます。

lpBuffervoid*out

親リソースを表す 1 つの NETRESOURCE 構造体を受け取るバッファーへのポインターです。この関数は、構造体の lpRemoteName、lpProvider、dwType、dwDisplayType、dwUsage の各メンバーを返します。その他のメンバーはすべて NULL に設定されます。

lpRemoteName メンバーは、親リソースのリモート名を指します。この名前は、 WNetEnumResource 関数による列挙で返される名前と同じ構文を使用します。呼び出し元は、文字列比較によって WNetGetResourceParent が返したリソースが WNetEnumResource が返したものと同じかどうかを判断できます。入力したリソースがいずれのネットワークにも親を持たない場合、lpRemoteName メンバーは NULL として返されます。

dwUsage メンバーに RESOURCEUSAGE_CONNECTABLE ビットが設定されている場合は、その親リソースに接続できることを示します。ただし、ネットワーク上で利用できる場合に限ります。

lpcbBufferDWORD*inout呼び出し時に lpBuffer バッファーのサイズをバイト単位で指定する場所へのポインターです。バッファーが結果を格納するには小さすぎる場合、この場所に必要なバッファーサイズが格納され、関数は ERROR_MORE_DATA を返します。

戻り値の型: WIN32_ERROR

公式ドキュメント

WNetGetResourceParent 関数は、ネットワーク参照階層におけるネットワークリソースの親を返します。参照は、指定されたネットワークリソースの位置から開始されます。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は システムエラーコード であり、たとえば次のいずれかの値になります。

リターンコード 説明
ERROR_ACCESS_DENIED
呼び出し元にそのネットワークリソースへのアクセス権がありません。
ERROR_BAD_NET_NAME
入力された lpRemoteName メンバーが、いずれのネットワークにも存在するネットワークリソースではありません。
ERROR_BAD_PROVIDER
入力された lpProvider メンバーが、インストールされているどのネットワークプロバイダーとも一致しません。
ERROR_MORE_DATA
lpBuffer パラメーターが指すバッファーが小さすぎます。
ERROR_NOT_AUTHENTICATED
呼び出し元に、親の名前を取得するために必要なアクセス許可がありません。

解説(Remarks)

WNetGetResourceParent 関数は通常、ユーザーが入力したネットワークパスを解析して解釈するために、 WNetGetResourceInformation 関数と組み合わせて使用します。

WNetGetResourceInformation 関数とは異なり、WNetGetResourceParent 関数は、リソースの構文上に親が含まれている場合、そのリソースが実際に存在するかどうかにかかわらず親を返します。 WNetGetResourceParent は通常、ネットワークリソースを階層形式でユーザーに表示するアプリケーションでのみ使用してください。この種のアプリケーションの代表例としては、Windows エクスプローラーと [ファイルを開く] ダイアログボックスの 2 つが挙げられます。なお、返されるリソースの種類について何らかの前提を置くべきではありません。

NETRESOURCE 構造体から情報を取得するには、 WNetEnumResource、 WNetGetResourceInformation、または WNetGetResourceParent 関数を呼び出します。また、 NETRESOURCE 構造体のメンバーを使用して、ネットワークリソース情報を構築することもできます。

WNetGetResourceParent の不適切な使用例としては、指定したサーバーが属するドメインの名前を調べる用途が挙げられます。参照階層においてドメインがサーバーの直上に現れるネットワークでは、この関数がたまたま正しいドメイン名を返すことがあります。しかし、それ以外のネットワークでは正しくない結果が返されます。

メモ

winnetwk.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WNetGetResourceParent を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// MPR.dll  (Unicode / -W)
#include <windows.h>

WIN32_ERROR WNetGetResourceParentW(
    NETRESOURCEW* lpNetResource,
    void* lpBuffer,
    DWORD* lpcbBuffer
);
[DllImport("MPR.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint WNetGetResourceParentW(
    IntPtr lpNetResource,   // NETRESOURCEW*
    IntPtr lpBuffer,   // void* out
    ref uint lpcbBuffer   // DWORD* in/out
);
<DllImport("MPR.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function WNetGetResourceParentW(
    lpNetResource As IntPtr,   ' NETRESOURCEW*
    lpBuffer As IntPtr,   ' void* out
    ByRef lpcbBuffer As UInteger   ' DWORD* in/out
) As UInteger
End Function
' lpNetResource : NETRESOURCEW*
' lpBuffer : void* out
' lpcbBuffer : DWORD* in/out
Declare PtrSafe Function WNetGetResourceParentW Lib "mpr" ( _
    ByVal lpNetResource As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByRef lpcbBuffer As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WNetGetResourceParentW = ctypes.windll.mpr.WNetGetResourceParentW
WNetGetResourceParentW.restype = wintypes.DWORD
WNetGetResourceParentW.argtypes = [
    ctypes.c_void_p,  # lpNetResource : NETRESOURCEW*
    ctypes.POINTER(None),  # lpBuffer : void* out
    ctypes.POINTER(wintypes.DWORD),  # lpcbBuffer : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPR.dll')
WNetGetResourceParentW = Fiddle::Function.new(
  lib['WNetGetResourceParentW'],
  [
    Fiddle::TYPE_VOIDP,  # lpNetResource : NETRESOURCEW*
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    Fiddle::TYPE_VOIDP,  # lpcbBuffer : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "mpr")]
extern "system" {
    fn WNetGetResourceParentW(
        lpNetResource: *mut NETRESOURCEW,  // NETRESOURCEW*
        lpBuffer: *mut (),  // void* out
        lpcbBuffer: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Unicode)]
public static extern uint WNetGetResourceParentW(IntPtr lpNetResource, IntPtr lpBuffer, ref uint lpcbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetGetResourceParentW' -Namespace Win32 -PassThru
# $api::WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
#uselib "MPR.dll"
#func global WNetGetResourceParentW "WNetGetResourceParentW" wptr, wptr, wptr
; WNetGetResourceParentW varptr(lpNetResource), lpBuffer, varptr(lpcbBuffer)   ; 戻り値は stat
; lpNetResource : NETRESOURCEW* -> "wptr"
; lpBuffer : void* out -> "wptr"
; lpcbBuffer : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPR.dll"
#cfunc global WNetGetResourceParentW "WNetGetResourceParentW" var, sptr, var
; res = WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
; lpNetResource : NETRESOURCEW* -> "var"
; lpBuffer : void* out -> "sptr"
; lpcbBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR WNetGetResourceParentW(NETRESOURCEW* lpNetResource, void* lpBuffer, DWORD* lpcbBuffer)
#uselib "MPR.dll"
#cfunc global WNetGetResourceParentW "WNetGetResourceParentW" var, intptr, var
; res = WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
; lpNetResource : NETRESOURCEW* -> "var"
; lpBuffer : void* out -> "intptr"
; lpcbBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mpr = windows.NewLazySystemDLL("MPR.dll")
	procWNetGetResourceParentW = mpr.NewProc("WNetGetResourceParentW")
)

// lpNetResource (NETRESOURCEW*), lpBuffer (void* out), lpcbBuffer (DWORD* in/out)
r1, _, err := procWNetGetResourceParentW.Call(
	uintptr(lpNetResource),
	uintptr(lpBuffer),
	uintptr(lpcbBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function WNetGetResourceParentW(
  lpNetResource: Pointer;   // NETRESOURCEW*
  lpBuffer: Pointer;   // void* out
  lpcbBuffer: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetGetResourceParentW';
result := DllCall("MPR\WNetGetResourceParentW"
    , "Ptr", lpNetResource   ; NETRESOURCEW*
    , "Ptr", lpBuffer   ; void* out
    , "Ptr", lpcbBuffer   ; DWORD* in/out
    , "UInt")   ; return: WIN32_ERROR
●WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer) = DLL("MPR.dll", "dword WNetGetResourceParentW(void*, void*, void*)")
# 呼び出し: WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
# lpNetResource : NETRESOURCEW* -> "void*"
# lpBuffer : void* out -> "void*"
# lpcbBuffer : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "mpr" fn WNetGetResourceParentW(
    lpNetResource: [*c]NETRESOURCEW, // NETRESOURCEW*
    lpBuffer: ?*anyopaque, // void* out
    lpcbBuffer: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WNetGetResourceParentW(
    lpNetResource: ptr NETRESOURCEW,  # NETRESOURCEW*
    lpBuffer: pointer,  # void* out
    lpcbBuffer: ptr uint32  # DWORD* in/out
): uint32 {.importc: "WNetGetResourceParentW", stdcall, dynlib: "MPR.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "mpr");
extern(Windows)
uint WNetGetResourceParentW(
    NETRESOURCEW* lpNetResource,   // NETRESOURCEW*
    void* lpBuffer,   // void* out
    uint* lpcbBuffer   // DWORD* in/out
);
ccall((:WNetGetResourceParentW, "MPR.dll"), stdcall, UInt32,
      (Ptr{NETRESOURCEW}, Ptr{Cvoid}, Ptr{UInt32}),
      lpNetResource, lpBuffer, lpcbBuffer)
# lpNetResource : NETRESOURCEW* -> Ptr{NETRESOURCEW}
# lpBuffer : void* out -> Ptr{Cvoid}
# lpcbBuffer : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WNetGetResourceParentW(
    void* lpNetResource,
    void* lpBuffer,
    uint32_t* lpcbBuffer);
]]
local mpr = ffi.load("mpr")
-- mpr.WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
-- lpNetResource : NETRESOURCEW*
-- lpBuffer : void* out
-- lpcbBuffer : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const WNetGetResourceParentW = lib.func('__stdcall', 'WNetGetResourceParentW', 'uint32_t', ['void *', 'void *', 'uint32_t *']);
// WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
// lpNetResource : NETRESOURCEW* -> 'void *'
// lpBuffer : void* out -> 'void *'
// lpcbBuffer : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPR.dll", {
  WNetGetResourceParentW: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer)
// lpNetResource : NETRESOURCEW* -> "pointer"
// lpBuffer : void* out -> "pointer"
// lpcbBuffer : DWORD* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WNetGetResourceParentW(
    void* lpNetResource,
    void* lpBuffer,
    uint32_t* lpcbBuffer);
C, "MPR.dll");
// $ffi->WNetGetResourceParentW(lpNetResource, lpBuffer, lpcbBuffer);
// lpNetResource : NETRESOURCEW*
// lpBuffer : void* out
// lpcbBuffer : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Mpr extends StdCallLibrary {
    Mpr INSTANCE = Native.load("mpr", Mpr.class, W32APIOptions.UNICODE_OPTIONS);
    int WNetGetResourceParentW(
        Pointer lpNetResource,   // NETRESOURCEW*
        Pointer lpBuffer,   // void* out
        IntByReference lpcbBuffer   // DWORD* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("mpr")]
lib LibMPR
  fun WNetGetResourceParentW = WNetGetResourceParentW(
    lpNetResource : NETRESOURCEW*,   # NETRESOURCEW*
    lpBuffer : Void*,   # void* out
    lpcbBuffer : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WNetGetResourceParentWNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef WNetGetResourceParentWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final WNetGetResourceParentW = DynamicLibrary.open('MPR.dll')
    .lookupFunction<WNetGetResourceParentWNative, WNetGetResourceParentWDart>('WNetGetResourceParentW');
// lpNetResource : NETRESOURCEW* -> Pointer<Void>
// lpBuffer : void* out -> Pointer<Void>
// lpcbBuffer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WNetGetResourceParentW(
  lpNetResource: Pointer;   // NETRESOURCEW*
  lpBuffer: Pointer;   // void* out
  lpcbBuffer: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetGetResourceParentW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WNetGetResourceParentW"
  c_WNetGetResourceParentW :: Ptr () -> Ptr () -> Ptr Word32 -> IO Word32
-- lpNetResource : NETRESOURCEW* -> Ptr ()
-- lpBuffer : void* out -> Ptr ()
-- lpcbBuffer : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wnetgetresourceparentw =
  foreign "WNetGetResourceParentW"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* lpNetResource : NETRESOURCEW* -> (ptr void) *)
(* lpBuffer : void* out -> (ptr void) *)
(* lpcbBuffer : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mpr (t "MPR.dll"))
(cffi:use-foreign-library mpr)

(cffi:defcfun ("WNetGetResourceParentW" wnet-get-resource-parent-w :convention :stdcall) :uint32
  (lp-net-resource :pointer)   ; NETRESOURCEW*
  (lp-buffer :pointer)   ; void* out
  (lpcb-buffer :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WNetGetResourceParentW = Win32::API::More->new('MPR',
    'DWORD WNetGetResourceParentW(LPVOID lpNetResource, LPVOID lpBuffer, LPVOID lpcbBuffer)');
# my $ret = $WNetGetResourceParentW->Call($lpNetResource, $lpBuffer, $lpcbBuffer);
# lpNetResource : NETRESOURCEW* -> LPVOID
# lpBuffer : void* out -> LPVOID
# lpcbBuffer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型