ホーム › NetworkManagement.WNet › WNetOpenEnumA

WNetOpenEnumA

関数

ネットワークリソースの列挙を開始する(ANSI版)。

DLLMPR.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

WIN32_ERROR WNetOpenEnumA(
    NET_RESOURCE_SCOPE dwScope,
    NET_RESOURCE_TYPE dwType,
    WNET_OPEN_ENUM_USAGE dwUsage,
    NETRESOURCEA* lpNetResource,   // optional
    HANDLE* lphEnum
);

パラメーター

名前

型

方向

説明

dwScope

NET_RESOURCE_SCOPE

列挙のスコープ。このパラメーターには、次のいずれかの値を指定できます。

値	意味
RESOURCE_CONNECTED	現在接続されているすべてのリソースを列挙します。この関数は dwUsage パラメーターを無視します。詳しくは、後述の「解説」セクションを参照してください。
RESOURCE_CONTEXT	呼び出し元のネットワークコンテキスト内のリソースのみを列挙します。ネットワークコンピューター表示の場合はこの値を指定します。この関数は dwUsage パラメーターを無視します。
RESOURCE_GLOBALNET	ネットワーク上のすべてのリソースを列挙します。
RESOURCE_REMEMBERED	記憶されている (永続的な) 接続をすべて列挙します。この関数は dwUsage パラメーターを無視します。

dwType

NET_RESOURCE_TYPE

列挙するリソースの種類。このパラメーターには、次の値の組み合わせを指定できます。

値	意味
RESOURCETYPE_ANY	すべてのリソース。この値は RESOURCETYPE_DISK または RESOURCETYPE_PRINT と組み合わせることはできません。
RESOURCETYPE_DISK	すべてのディスクリソース。
RESOURCETYPE_PRINT	すべての印刷リソース。

ネットワークプロバイダーが印刷リソースとディスクリソースを区別できない場合は、すべてのリソースを列挙することがあります。

dwUsage

WNET_OPEN_ENUM_USAGE

列挙するリソースの使用種別。このパラメーターには、次の値の組み合わせを指定できます。

値	意味
0	すべてのリソース。
RESOURCEUSAGE_CONNECTABLE	接続可能なすべてのリソース。
RESOURCEUSAGE_CONTAINER	すべてのコンテナーリソース。
RESOURCEUSAGE_ATTACHED	この値を設定すると、ユーザーが認証されていない場合に WNetOpenEnum は強制的に失敗します。ネットワークが認証なしでの列挙を許可している場合でも、この関数は失敗します。
RESOURCEUSAGE_ALL	この値を設定することは、RESOURCEUSAGE_CONNECTABLE、RESOURCEUSAGE_CONTAINER、および RESOURCEUSAGE_ATTACHED を設定することと同等です。

このパラメーターは、dwScope パラメーターが RESOURCE_GLOBALNET と等しい場合を除いて無視されます。詳しくは、後述の「解説」セクションを参照してください。

lpNetResource

NETRESOURCEA*

inoptional

列挙するコンテナーを指定する NETRESOURCE 構造体へのポインター。dwScope パラメーターが RESOURCE_GLOBALNET でない場合、このパラメーターは NULL でなければなりません。

このパラメーターが NULL の場合は、ネットワークのルートが想定されます。(システムはネットワークを階層として構成します。ルートはネットワーク内で最上位のコンテナーです。)

このパラメーターが NULL でない場合は、 NETRESOURCE 構造体を指している必要があります。この構造体は、アプリケーションが値を設定することも、 WNetEnumResource 関数の呼び出しによって返されたものを使用することもできます。 NETRESOURCE 構造体はコンテナーリソースを指定しなければなりません。つまり、dwUsage メンバーに RESOURCEUSAGE_CONTAINER 値を指定する必要があります。

すべてのネットワークリソースを列挙するには、アプリケーションは lpNetResource パラメーターを NULL に設定して WNetOpenEnum を呼び出すことで列挙を開始し、返されたハンドルを使用して WNetEnumResource を呼び出し、リソースを列挙します。 WNetEnumResource 関数が返す NETRESOURCE 配列内のリソースのいずれかがコンテナーリソースである場合は、 WNetOpenEnum を呼び出してそのリソースを開き、さらに列挙を進めることができます。

lphEnum

HANDLE*

out

後続の WNetEnumResource の呼び出しで使用できる列挙ハンドルへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

WNetOpenEnum 関数は、ネットワークリソースまたは既存の接続の列挙を開始します。WNetEnumResource 関数を呼び出すことで列挙を継続できます。(ANSI)

戻り値

関数が成功すると、戻り値は NO_ERROR です。

関数が失敗すると、戻り値は次のいずれかのようなシステムエラーコードです。

リターンコード	説明
ERROR_NOT_CONTAINER	lpNetResource パラメーターがコンテナーを指していません。
ERROR_INVALID_PARAMETER	dwScope または dwType パラメーターが無効であるか、パラメーターの組み合わせが無効です。
ERROR_NO_NETWORK	ネットワークが利用できません。
ERROR_EXTENDED_ERROR	ネットワーク固有のエラーが発生しました。エラーの説明を取得するには、 WNetGetLastError 関数を呼び出します。
ERROR_INVALID_ADDRESS	NETRESOURCE 構造体で指定されたリモートネットワークリソース名が、無効なネットワークアドレスに解決されました。

解説(Remarks)

dwScope パラメーターが RESOURCE_CONNECTED と等しい場合、Microsoft LAN Manager ネットワークを使用して行われたネットワーク接続は、その接続を行ったアプリケーションが WNetOpenEnum 関数を呼び出すアプリケーションとは異なるログオンセッションで実行されていたときには、列挙から除外されます。これは、Microsoft LAN Manager を使用して行われた接続が、その接続を行ったアプリケーションと同じログオンセッションで実行されているアプリケーションからのみ参照できるためです。(接続を列挙に含めるには、アプリケーションがその接続を作成したユーザーアカウントで実行されているだけでは不十分です。)

dwScope パラメーターにおける RESOURCE_CONTEXT の正確な解釈は、そのマシンにインストールされているネットワークによって異なります。

WNetOpenEnum 関数は、単一のコンテナー内のリソースの列挙を開始するために使用します。次の例は、Microsoft LAN Manager ネットワークと Novell NetWare ネットワークの階層構造を示し、コンテナーを明示しています。

LanMan (コンテナー。この場合はプロバイダー) 
  ACCOUNTING (コンテナー。この場合はドメイン) 
    \\ACCTSPAY (コンテナー。この場合はサーバー) 
      PAYFILES (ディスク) 
      LASERJET (印刷) 
 
NetWare (コンテナー。この場合はプロバイダー) 
  MARKETING (コンテナー。この場合はサーバー) 
    SYS (ディスク。NetWare サーバー上の最初のもの) 
    ANOTHERVOLUME (ディスク) 
    LASERJET (印刷)

例

ネットワーク上のすべてのリソースを列挙するアプリケーション定義の関数を示すコードサンプルについては、 Enumerating Network Resources を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WNetOpenEnumA(
    NET_RESOURCE_SCOPE dwScope,
    NET_RESOURCE_TYPE dwType,
    WNET_OPEN_ENUM_USAGE dwUsage,
    NETRESOURCEA* lpNetResource,   // optional
    HANDLE* lphEnum
);

[DllImport("MPR.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint WNetOpenEnumA(
    uint dwScope,   // NET_RESOURCE_SCOPE
    uint dwType,   // NET_RESOURCE_TYPE
    uint dwUsage,   // WNET_OPEN_ENUM_USAGE
    IntPtr lpNetResource,   // NETRESOURCEA* optional
    IntPtr lphEnum   // HANDLE* out
);

<DllImport("MPR.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function WNetOpenEnumA(
    dwScope As UInteger,   ' NET_RESOURCE_SCOPE
    dwType As UInteger,   ' NET_RESOURCE_TYPE
    dwUsage As UInteger,   ' WNET_OPEN_ENUM_USAGE
    lpNetResource As IntPtr,   ' NETRESOURCEA* optional
    lphEnum As IntPtr   ' HANDLE* out
) As UInteger
End Function

' dwScope : NET_RESOURCE_SCOPE
' dwType : NET_RESOURCE_TYPE
' dwUsage : WNET_OPEN_ENUM_USAGE
' lpNetResource : NETRESOURCEA* optional
' lphEnum : HANDLE* out
Declare PtrSafe Function WNetOpenEnumA Lib "mpr" ( _
    ByVal dwScope As Long, _
    ByVal dwType As Long, _
    ByVal dwUsage As Long, _
    ByVal lpNetResource As LongPtr, _
    ByVal lphEnum As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WNetOpenEnumA = ctypes.windll.mpr.WNetOpenEnumA
WNetOpenEnumA.restype = wintypes.DWORD
WNetOpenEnumA.argtypes = [
    wintypes.DWORD,  # dwScope : NET_RESOURCE_SCOPE
    wintypes.DWORD,  # dwType : NET_RESOURCE_TYPE
    wintypes.DWORD,  # dwUsage : WNET_OPEN_ENUM_USAGE
    ctypes.c_void_p,  # lpNetResource : NETRESOURCEA* optional
    ctypes.c_void_p,  # lphEnum : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPR.dll')
WNetOpenEnumA = Fiddle::Function.new(
  lib['WNetOpenEnumA'],
  [
    -Fiddle::TYPE_INT,  # dwScope : NET_RESOURCE_SCOPE
    -Fiddle::TYPE_INT,  # dwType : NET_RESOURCE_TYPE
    -Fiddle::TYPE_INT,  # dwUsage : WNET_OPEN_ENUM_USAGE
    Fiddle::TYPE_VOIDP,  # lpNetResource : NETRESOURCEA* optional
    Fiddle::TYPE_VOIDP,  # lphEnum : HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "mpr")]
extern "system" {
    fn WNetOpenEnumA(
        dwScope: u32,  // NET_RESOURCE_SCOPE
        dwType: u32,  // NET_RESOURCE_TYPE
        dwUsage: u32,  // WNET_OPEN_ENUM_USAGE
        lpNetResource: *mut NETRESOURCEA,  // NETRESOURCEA* optional
        lphEnum: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MPR.dll", CharSet = CharSet.Ansi)]
public static extern uint WNetOpenEnumA(uint dwScope, uint dwType, uint dwUsage, IntPtr lpNetResource, IntPtr lphEnum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPR_WNetOpenEnumA' -Namespace Win32 -PassThru
# $api::WNetOpenEnumA(dwScope, dwType, dwUsage, lpNetResource, lphEnum)

#uselib "MPR.dll"
#func global WNetOpenEnumA "WNetOpenEnumA" sptr, sptr, sptr, sptr, sptr
; WNetOpenEnumA dwScope, dwType, dwUsage, varptr(lpNetResource), lphEnum   ; 戻り値は stat
; dwScope : NET_RESOURCE_SCOPE -> "sptr"
; dwType : NET_RESOURCE_TYPE -> "sptr"
; dwUsage : WNET_OPEN_ENUM_USAGE -> "sptr"
; lpNetResource : NETRESOURCEA* optional -> "sptr"
; lphEnum : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MPR.dll"
#cfunc global WNetOpenEnumA "WNetOpenEnumA" int, int, int, var, sptr
; res = WNetOpenEnumA(dwScope, dwType, dwUsage, lpNetResource, lphEnum)
; dwScope : NET_RESOURCE_SCOPE -> "int"
; dwType : NET_RESOURCE_TYPE -> "int"
; dwUsage : WNET_OPEN_ENUM_USAGE -> "int"
; lpNetResource : NETRESOURCEA* optional -> "var"
; lphEnum : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MPR.dll"
#cfunc global WNetOpenEnumA "WNetOpenEnumA" int, int, int, sptr, sptr
; res = WNetOpenEnumA(dwScope, dwType, dwUsage, varptr(lpNetResource), lphEnum)
; dwScope : NET_RESOURCE_SCOPE -> "int"
; dwType : NET_RESOURCE_TYPE -> "int"
; dwUsage : WNET_OPEN_ENUM_USAGE -> "int"
; lpNetResource : NETRESOURCEA* optional -> "sptr"
; lphEnum : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。