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

WNetGetResourceParentA

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

シグネチャ

// MPR.dll  (ANSI / -A)
#include <windows.h>

WIN32_ERROR WNetGetResourceParentA(
    NETRESOURCEA* lpNetResource,
    void* lpBuffer,
    DWORD* lpcbBuffer
);

パラメーター

名前型方向説明
lpNetResourceNETRESOURCEA*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 関数は、ネットワーク参照階層におけるネットワークリソースの親を返します。参照は、指定されたネットワークリソースの位置から開始されます。(ANSI)

戻り値

関数が成功した場合、戻り値は 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 は通常、ネットワークリソースを階層形式でユーザーに表示するアプリケーションでのみ使用してください。エクスプローラーと [ファイルを開く] ダイアログボックスは、この種のアプリケーションのよく知られた例です。なお、返されるリソースの種類について何らかの前提を置くべきではありません。

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

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

メモ

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

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

各言語での呼び出し定義

// MPR.dll  (ANSI / -A)
#include <windows.h>

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

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

lib = Fiddle.dlopen('MPR.dll')
WNetGetResourceParentA = Fiddle::Function.new(
  lib['WNetGetResourceParentA'],
  [
    Fiddle::TYPE_VOIDP,  # lpNetResource : NETRESOURCEA*
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    Fiddle::TYPE_VOIDP,  # lpcbBuffer : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mpr")]
extern "system" {
    fn WNetGetResourceParentA(
        lpNetResource: *mut NETRESOURCEA,  // NETRESOURCEA*
        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.Ansi)]
public static extern uint WNetGetResourceParentA(IntPtr lpNetResource, IntPtr lpBuffer, ref uint lpcbBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetGetResourceParentA' -Namespace Win32 -PassThru
# $api::WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
#uselib "MPR.dll"
#func global WNetGetResourceParentA "WNetGetResourceParentA" sptr, sptr, sptr
; WNetGetResourceParentA varptr(lpNetResource), lpBuffer, varptr(lpcbBuffer)   ; 戻り値は stat
; lpNetResource : NETRESOURCEA* -> "sptr"
; lpBuffer : void* out -> "sptr"
; lpcbBuffer : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPR.dll"
#cfunc global WNetGetResourceParentA "WNetGetResourceParentA" var, sptr, var
; res = WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
; lpNetResource : NETRESOURCEA* -> "var"
; lpBuffer : void* out -> "sptr"
; lpcbBuffer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR WNetGetResourceParentA(NETRESOURCEA* lpNetResource, void* lpBuffer, DWORD* lpcbBuffer)
#uselib "MPR.dll"
#cfunc global WNetGetResourceParentA "WNetGetResourceParentA" var, intptr, var
; res = WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
; lpNetResource : NETRESOURCEA* -> "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")
	procWNetGetResourceParentA = mpr.NewProc("WNetGetResourceParentA")
)

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

extern "mpr" fn WNetGetResourceParentA(
    lpNetResource: [*c]NETRESOURCEA, // NETRESOURCEA*
    lpBuffer: ?*anyopaque, // void* out
    lpcbBuffer: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc WNetGetResourceParentA(
    lpNetResource: ptr NETRESOURCEA,  # NETRESOURCEA*
    lpBuffer: pointer,  # void* out
    lpcbBuffer: ptr uint32  # DWORD* in/out
): uint32 {.importc: "WNetGetResourceParentA", stdcall, dynlib: "MPR.dll".}
pragma(lib, "mpr");
extern(Windows)
uint WNetGetResourceParentA(
    NETRESOURCEA* lpNetResource,   // NETRESOURCEA*
    void* lpBuffer,   // void* out
    uint* lpcbBuffer   // DWORD* in/out
);
ccall((:WNetGetResourceParentA, "MPR.dll"), stdcall, UInt32,
      (Ptr{NETRESOURCEA}, Ptr{Cvoid}, Ptr{UInt32}),
      lpNetResource, lpBuffer, lpcbBuffer)
# lpNetResource : NETRESOURCEA* -> Ptr{NETRESOURCEA}
# lpBuffer : void* out -> Ptr{Cvoid}
# lpcbBuffer : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WNetGetResourceParentA(
    void* lpNetResource,
    void* lpBuffer,
    uint32_t* lpcbBuffer);
]]
local mpr = ffi.load("mpr")
-- mpr.WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
-- lpNetResource : NETRESOURCEA*
-- lpBuffer : void* out
-- lpcbBuffer : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MPR.dll');
const WNetGetResourceParentA = lib.func('__stdcall', 'WNetGetResourceParentA', 'uint32_t', ['void *', 'void *', 'uint32_t *']);
// WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
// lpNetResource : NETRESOURCEA* -> 'void *'
// lpBuffer : void* out -> 'void *'
// lpcbBuffer : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPR.dll", {
  WNetGetResourceParentA: { parameters: ["pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer)
// lpNetResource : NETRESOURCEA* -> "pointer"
// lpBuffer : void* out -> "pointer"
// lpcbBuffer : DWORD* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WNetGetResourceParentA(
    void* lpNetResource,
    void* lpBuffer,
    uint32_t* lpcbBuffer);
C, "MPR.dll");
// $ffi->WNetGetResourceParentA(lpNetResource, lpBuffer, lpcbBuffer);
// lpNetResource : NETRESOURCEA*
// 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.ASCII_OPTIONS);
    int WNetGetResourceParentA(
        Pointer lpNetResource,   // NETRESOURCEA*
        Pointer lpBuffer,   // void* out
        IntByReference lpcbBuffer   // DWORD* in/out
    );
}
@[Link("mpr")]
lib LibMPR
  fun WNetGetResourceParentA = WNetGetResourceParentA(
    lpNetResource : NETRESOURCEA*,   # NETRESOURCEA*
    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 WNetGetResourceParentANative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef WNetGetResourceParentADart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final WNetGetResourceParentA = DynamicLibrary.open('MPR.dll')
    .lookupFunction<WNetGetResourceParentANative, WNetGetResourceParentADart>('WNetGetResourceParentA');
// lpNetResource : NETRESOURCEA* -> Pointer<Void>
// lpBuffer : void* out -> Pointer<Void>
// lpcbBuffer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WNetGetResourceParentA(
  lpNetResource: Pointer;   // NETRESOURCEA*
  lpBuffer: Pointer;   // void* out
  lpcbBuffer: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'MPR.dll' name 'WNetGetResourceParentA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let wnetgetresourceparenta =
  foreign "WNetGetResourceParentA"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* lpNetResource : NETRESOURCEA* -> (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 ("WNetGetResourceParentA" wnet-get-resource-parent-a :convention :stdcall) :uint32
  (lp-net-resource :pointer)   ; NETRESOURCEA*
  (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 $WNetGetResourceParentA = Win32::API::More->new('MPR',
    'DWORD WNetGetResourceParentA(LPVOID lpNetResource, LPVOID lpBuffer, LPVOID lpcbBuffer)');
# my $ret = $WNetGetResourceParentA->Call($lpNetResource, $lpBuffer, $lpcbBuffer);
# lpNetResource : NETRESOURCEA* -> LPVOID
# lpBuffer : void* out -> LPVOID
# lpcbBuffer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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