NetShareGetInfo
関数シグネチャ
// NETAPI32.dll
#include <windows.h>
DWORD NetShareGetInfo(
LPWSTR servername, // optional
LPWSTR netname,
DWORD level,
BYTE** bufptr
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| servername | LPWSTR | inoptional | 関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインターです。このパラメーターが NULL の場合、ローカルコンピューターが使用されます。 | ||||||||||||||||
| netname | LPWSTR | in | 情報を返す対象となる共有の名前を指定する文字列へのポインターです。 | ||||||||||||||||
| level | DWORD | in | データの情報レベルを指定します。このパラメーターには次のいずれかの値を指定できます。
| ||||||||||||||||
| bufptr | BYTE** | out | データを受け取るバッファーへのポインターです。このデータの形式は level パラメーターの値に依存します。詳細については、 Network Management Function Buffers を参照してください。 このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。 |
戻り値の型: DWORD
公式ドキュメント
サーバー上の特定の共有リソースに関する情報を取得します。
戻り値
関数が成功した場合、戻り値は NERR_Success です。
関数が失敗した場合、戻り値は次のエラーコードのいずれかになります。
| 戻り値 | 説明 |
|---|---|
| ユーザーが要求された情報にアクセスできません。 | |
| level パラメーターに指定された値が無効です。 | |
| 指定されたパラメーターが無効です。 | |
| 使用可能なメモリが不足しています。 | |
|
共有名が存在しません。 |
解説(Remarks)
この関数は Server Message Block (SMB) 共有にのみ適用されます。分散ファイルシステム (DFS) や WebDAV 共有などの他の種類の共有については、すべての種類の共有をサポートする Windows ネットワーク (WNet) 関数 を使用してください。
対話型ユーザー(マシンにローカルでログオンしているユーザー)の場合、NetShareGetInfo 関数を実行するために特別なグループメンバーシップは必要ありません。非対話型ユーザーの場合、レベル 2、502、503 で NetShareEnum 関数を正常に実行するには、Administrator、Power User、Print Operator、または Server Operator グループのメンバーシップが必要です。レベル 0 またはレベル 1 の呼び出しには、特別なグループメンバーシップは必要ありません。
Windows Server 2003 および Windows XP: すべてのユーザーについて、レベル 2 および 502 で NetShareGetInfo 関数を正常に実行するには、Administrator、Power User、Print Operator、または Server Operator グループのメンバーシップが必要です。
Active Directory 向けにプログラミングを行っている場合、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで、ネットワーク管理共有関数を呼び出して実現できる機能と同じ機能を実現できることがあります。詳細については、 IADsFileShare を参照してください。
level パラメーターに 503 を指定する場合、SHARE_INFO_503 構造体の shi503_servername メンバーで指定されたリモートサーバーは、NetServerTransportAddEx 関数を使用してトランスポートプロトコルにバインドされている必要があります。NetServerTransportAddEx の呼び出しでは、level パラメーターに 2 または 3 を指定し、トランスポートプロトコルの SERVER_TRANSPORT_INFO_2 構造体に SVTI2_SCOPED_NAME フラグを指定している必要があります。
例
次のコードサンプルは、 NetShareGetInfo 関数の呼び出しを使用して、特定の共有リソースに関する情報を取得する方法を示しています。このサンプルでは、情報レベル 502 ( SHARE_INFO_502) を指定して NetShareGetInfo を呼び出します。呼び出しが成功すると、取得したデータを出力します。また、このサンプルでは IsValidSecurityDescriptor 関数を呼び出して shi502_security_descriptor メンバーを検証します。最後に、情報バッファーに割り当てられたメモリを解放します。
#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <stdio.h>
#include <lm.h>
#pragma comment(lib, "Netapi32.lib")
#pragma comment(lib, "Advapi32.lib")
void wmain( int argc, TCHAR *lpszArgv[ ])
{
PSHARE_INFO_502 BufPtr;
NET_API_STATUS res;
LPTSTR lpszServer = NULL, lpszShare;
//
// Check command line arguments.
//
switch(argc)
{
case 3:
lpszServer = lpszArgv[2];
case 2:
lpszShare = lpszArgv[1];
break;
default:
printf("Usage: NetShareGetInfo sharename <servername>\n");
return;
}
//
// Call the NetShareGetInfo function, specifying level 502.
//
if((res = NetShareGetInfo (lpszServer,lpszShare,502,(LPBYTE *) &BufPtr)) == ERROR_SUCCESS)
{
//
// Print the retrieved data.
//
printf("%S\t%S\t%u\n",BufPtr->shi502_netname, BufPtr->shi502_path, BufPtr->shi502_current_uses);
//
// Validate the value of the
// shi502_security_descriptor member.
//
if (IsValidSecurityDescriptor(BufPtr->shi502_security_descriptor))
printf("It has a valid Security Descriptor.\n");
else
printf("It does not have a valid Security Descriptor.\n");
//
// Free the allocated memory.
//
NetApiBufferFree(BufPtr);
}
else
printf("Error: %ld\n",res);
return;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// NETAPI32.dll
#include <windows.h>
DWORD NetShareGetInfo(
LPWSTR servername, // optional
LPWSTR netname,
DWORD level,
BYTE** bufptr
);[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetShareGetInfo(
[MarshalAs(UnmanagedType.LPWStr)] string servername, // LPWSTR optional
[MarshalAs(UnmanagedType.LPWStr)] string netname, // LPWSTR
uint level, // DWORD
IntPtr bufptr // BYTE** out
);<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetShareGetInfo(
<MarshalAs(UnmanagedType.LPWStr)> servername As String, ' LPWSTR optional
<MarshalAs(UnmanagedType.LPWStr)> netname As String, ' LPWSTR
level As UInteger, ' DWORD
bufptr As IntPtr ' BYTE** out
) As UInteger
End Function' servername : LPWSTR optional
' netname : LPWSTR
' level : DWORD
' bufptr : BYTE** out
Declare PtrSafe Function NetShareGetInfo Lib "netapi32" ( _
ByVal servername As LongPtr, _
ByVal netname As LongPtr, _
ByVal level As Long, _
ByVal bufptr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
NetShareGetInfo = ctypes.windll.netapi32.NetShareGetInfo
NetShareGetInfo.restype = wintypes.DWORD
NetShareGetInfo.argtypes = [
wintypes.LPCWSTR, # servername : LPWSTR optional
wintypes.LPCWSTR, # netname : LPWSTR
wintypes.DWORD, # level : DWORD
ctypes.c_void_p, # bufptr : BYTE** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('NETAPI32.dll')
NetShareGetInfo = Fiddle::Function.new(
lib['NetShareGetInfo'],
[
Fiddle::TYPE_VOIDP, # servername : LPWSTR optional
Fiddle::TYPE_VOIDP, # netname : LPWSTR
-Fiddle::TYPE_INT, # level : DWORD
Fiddle::TYPE_VOIDP, # bufptr : BYTE** out
],
-Fiddle::TYPE_INT)#[link(name = "netapi32")]
extern "system" {
fn NetShareGetInfo(
servername: *mut u16, // LPWSTR optional
netname: *mut u16, // LPWSTR
level: u32, // DWORD
bufptr: *mut *mut u8 // BYTE** out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetShareGetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string netname, uint level, IntPtr bufptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetShareGetInfo' -Namespace Win32 -PassThru
# $api::NetShareGetInfo(servername, netname, level, bufptr)#uselib "NETAPI32.dll"
#func global NetShareGetInfo "NetShareGetInfo" sptr, sptr, sptr, sptr
; NetShareGetInfo servername, netname, level, varptr(bufptr) ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; netname : LPWSTR -> "sptr"
; level : DWORD -> "sptr"
; bufptr : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "NETAPI32.dll" #cfunc global NetShareGetInfo "NetShareGetInfo" wstr, wstr, int, var ; res = NetShareGetInfo(servername, netname, level, bufptr) ; servername : LPWSTR optional -> "wstr" ; netname : LPWSTR -> "wstr" ; level : DWORD -> "int" ; bufptr : BYTE** out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll" #cfunc global NetShareGetInfo "NetShareGetInfo" wstr, wstr, int, sptr ; res = NetShareGetInfo(servername, netname, level, varptr(bufptr)) ; servername : LPWSTR optional -> "wstr" ; netname : LPWSTR -> "wstr" ; level : DWORD -> "int" ; bufptr : BYTE** out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD NetShareGetInfo(LPWSTR servername, LPWSTR netname, DWORD level, BYTE** bufptr) #uselib "NETAPI32.dll" #cfunc global NetShareGetInfo "NetShareGetInfo" wstr, wstr, int, var ; res = NetShareGetInfo(servername, netname, level, bufptr) ; servername : LPWSTR optional -> "wstr" ; netname : LPWSTR -> "wstr" ; level : DWORD -> "int" ; bufptr : BYTE** out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD NetShareGetInfo(LPWSTR servername, LPWSTR netname, DWORD level, BYTE** bufptr) #uselib "NETAPI32.dll" #cfunc global NetShareGetInfo "NetShareGetInfo" wstr, wstr, int, intptr ; res = NetShareGetInfo(servername, netname, level, varptr(bufptr)) ; servername : LPWSTR optional -> "wstr" ; netname : LPWSTR -> "wstr" ; level : DWORD -> "int" ; bufptr : BYTE** out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
procNetShareGetInfo = netapi32.NewProc("NetShareGetInfo")
)
// servername (LPWSTR optional), netname (LPWSTR), level (DWORD), bufptr (BYTE** out)
r1, _, err := procNetShareGetInfo.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(netname))),
uintptr(level),
uintptr(bufptr),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction NetShareGetInfo(
servername: PWideChar; // LPWSTR optional
netname: PWideChar; // LPWSTR
level: DWORD; // DWORD
bufptr: Pointer // BYTE** out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetShareGetInfo';result := DllCall("NETAPI32\NetShareGetInfo"
, "WStr", servername ; LPWSTR optional
, "WStr", netname ; LPWSTR
, "UInt", level ; DWORD
, "Ptr", bufptr ; BYTE** out
, "UInt") ; return: DWORD●NetShareGetInfo(servername, netname, level, bufptr) = DLL("NETAPI32.dll", "dword NetShareGetInfo(char*, char*, dword, void*)")
# 呼び出し: NetShareGetInfo(servername, netname, level, bufptr)
# servername : LPWSTR optional -> "char*"
# netname : LPWSTR -> "char*"
# level : DWORD -> "dword"
# bufptr : BYTE** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "netapi32" fn NetShareGetInfo(
servername: [*c]const u16, // LPWSTR optional
netname: [*c]const u16, // LPWSTR
level: u32, // DWORD
bufptr: [*c][*c]u8 // BYTE** out
) callconv(std.os.windows.WINAPI) u32;proc NetShareGetInfo(
servername: WideCString, # LPWSTR optional
netname: WideCString, # LPWSTR
level: uint32, # DWORD
bufptr: ptr uint8 # BYTE** out
): uint32 {.importc: "NetShareGetInfo", stdcall, dynlib: "NETAPI32.dll".}pragma(lib, "netapi32");
extern(Windows)
uint NetShareGetInfo(
const(wchar)* servername, // LPWSTR optional
const(wchar)* netname, // LPWSTR
uint level, // DWORD
ubyte** bufptr // BYTE** out
);ccall((:NetShareGetInfo, "NETAPI32.dll"), stdcall, UInt32,
(Cwstring, Cwstring, UInt32, Ptr{UInt8}),
servername, netname, level, bufptr)
# servername : LPWSTR optional -> Cwstring
# netname : LPWSTR -> Cwstring
# level : DWORD -> UInt32
# bufptr : BYTE** out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t NetShareGetInfo(
const uint16_t* servername,
const uint16_t* netname,
uint32_t level,
uint8_t** bufptr);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetShareGetInfo(servername, netname, level, bufptr)
-- servername : LPWSTR optional
-- netname : LPWSTR
-- level : DWORD
-- bufptr : BYTE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetShareGetInfo = lib.func('__stdcall', 'NetShareGetInfo', 'uint32_t', ['str16', 'str16', 'uint32_t', 'uint8_t *']);
// NetShareGetInfo(servername, netname, level, bufptr)
// servername : LPWSTR optional -> 'str16'
// netname : LPWSTR -> 'str16'
// level : DWORD -> 'uint32_t'
// bufptr : BYTE** out -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("NETAPI32.dll", {
NetShareGetInfo: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.NetShareGetInfo(servername, netname, level, bufptr)
// servername : LPWSTR optional -> "buffer"
// netname : LPWSTR -> "buffer"
// level : DWORD -> "u32"
// bufptr : BYTE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t NetShareGetInfo(
const uint16_t* servername,
const uint16_t* netname,
uint32_t level,
uint8_t** bufptr);
C, "NETAPI32.dll");
// $ffi->NetShareGetInfo(servername, netname, level, bufptr);
// servername : LPWSTR optional
// netname : LPWSTR
// level : DWORD
// bufptr : BYTE** 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 Netapi32 extends StdCallLibrary {
Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class);
int NetShareGetInfo(
WString servername, // LPWSTR optional
WString netname, // LPWSTR
int level, // DWORD
Pointer bufptr // BYTE** out
);
}@[Link("netapi32")]
lib LibNETAPI32
fun NetShareGetInfo = NetShareGetInfo(
servername : UInt16*, # LPWSTR optional
netname : UInt16*, # LPWSTR
level : UInt32, # DWORD
bufptr : UInt8** # BYTE** out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef NetShareGetInfoNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef NetShareGetInfoDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Uint8>);
final NetShareGetInfo = DynamicLibrary.open('NETAPI32.dll')
.lookupFunction<NetShareGetInfoNative, NetShareGetInfoDart>('NetShareGetInfo');
// servername : LPWSTR optional -> Pointer<Utf16>
// netname : LPWSTR -> Pointer<Utf16>
// level : DWORD -> Uint32
// bufptr : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function NetShareGetInfo(
servername: PWideChar; // LPWSTR optional
netname: PWideChar; // LPWSTR
level: DWORD; // DWORD
bufptr: Pointer // BYTE** out
): DWORD; stdcall;
external 'NETAPI32.dll' name 'NetShareGetInfo';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "NetShareGetInfo"
c_NetShareGetInfo :: CWString -> CWString -> Word32 -> Ptr Word8 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- netname : LPWSTR -> CWString
-- level : DWORD -> Word32
-- bufptr : BYTE** out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let netsharegetinfo =
foreign "NetShareGetInfo"
((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* netname : LPWSTR -> (ptr uint16_t) *)
(* level : DWORD -> uint32_t *)
(* bufptr : BYTE** out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)
(cffi:defcfun ("NetShareGetInfo" net-share-get-info :convention :stdcall) :uint32
(servername (:string :encoding :utf-16le)) ; LPWSTR optional
(netname (:string :encoding :utf-16le)) ; LPWSTR
(level :uint32) ; DWORD
(bufptr :pointer)) ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $NetShareGetInfo = Win32::API::More->new('NETAPI32',
'DWORD NetShareGetInfo(LPCWSTR servername, LPCWSTR netname, DWORD level, LPVOID bufptr)');
# my $ret = $NetShareGetInfo->Call($servername, $netname, $level, $bufptr);
# servername : LPWSTR optional -> LPCWSTR
# netname : LPWSTR -> LPCWSTR
# level : DWORD -> DWORD
# bufptr : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。