ホーム › Storage.FileSystem › NetShareDelEx

NetShareDelEx

関数

情報レベルを指定して共有リソースを削除する。

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

シグネチャ

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

DWORD NetShareDelEx(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* buf
);

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

関数を実行するリモートサーバーの DNS 名または NetBIOS 名を指定する文字列へのポインター。このパラメーターが NULL の場合、ローカルコンピューターが使用されます。

_WIN32_WINNT または FORCE_UNICODE が定義されている場合、この文字列は Unicode になります。

level

DWORD

データの情報レベルを指定します。このパラメーターには次のいずれかの値を指定できます。

値	意味
0, 1, 2, or 502	共有リソースに関する情報（リソース名、種類とアクセス許可、接続数を含む）を指定します。buf パラメーターは SHARE_INFO_0、SHARE_INFO_1、SHARE_INFO_2、または SHARE_INFO_502 構造体を指します。
503	共有リソースに関する情報（リソース名、種類とアクセス許可、接続数、およびその他の関連情報を含む）を指定します。buf パラメーターは SHARE_INFO_503 構造体を指します。

buf

BYTE*

データを指定するバッファーへのポインター。このデータの形式は level パラメーターの値によって異なります。詳細については、 Network Management Function Buffers を参照してください。

戻り値の型: DWORD

公式ドキュメント

サーバーの共有リソース一覧から共有名を削除し、その共有へのすべての接続を切断します。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値	説明
ERROR_INTERNAL_ERROR	内部エラーが発生しました。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_NOT_SUPPORTED	この要求はサポートされていません。

解説(Remarks)

level パラメーターに 503 を指定した場合、buf パラメーターは SHARE_INFO_503 構造体を指し、その構造体の shi503_netname メンバーと shi503_servername メンバーがサーバー上の共有リソースの検索に使用されます。その他のメンバーは無視されます。shi503_servername メンバーで指定するリモートサーバーは、NetServerTransportAddEx 関数を使用してトランスポートプロトコルにバインドされている必要があります。NetServerTransportAddEx の呼び出しでは、level パラメーターに 2 または 3 を指定し、トランスポートプロトコルの SERVER_TRANSPORT_INFO_2 構造体で SVTI2_SCOPED_NAME フラグを指定しておく必要があります。

level パラメーターに 0、1、2、または 502 を指定した場合、buf パラメーターは SHARE_INFO_0、SHARE_INFO_1、SHARE_INFO_2、または SHARE_INFO_502 構造体を指し、その構造体の shi0_netname、shi1_netname、shi2_netname、または shi502_netname メンバーが使用されます。その他のメンバーは無視されます。

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

各言語での呼び出し定義

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

DWORD NetShareDelEx(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* buf
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetShareDelEx(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    uint level,   // DWORD
    IntPtr buf   // BYTE*
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetShareDelEx(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    level As UInteger,   ' DWORD
    buf As IntPtr   ' BYTE*
) As UInteger
End Function

' servername : LPWSTR optional
' level : DWORD
' buf : BYTE*
Declare PtrSafe Function NetShareDelEx Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal level As Long, _
    ByVal buf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NetShareDelEx = ctypes.windll.netapi32.NetShareDelEx
NetShareDelEx.restype = wintypes.DWORD
NetShareDelEx.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # buf : BYTE*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetShareDelEx = Fiddle::Function.new(
  lib['NetShareDelEx'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    -Fiddle::TYPE_INT,  # level : DWORD
    Fiddle::TYPE_VOIDP,  # buf : BYTE*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "netapi32")]
extern "system" {
    fn NetShareDelEx(
        servername: *mut u16,  // LPWSTR optional
        level: u32,  // DWORD
        buf: *mut u8  // BYTE*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetShareDelEx([MarshalAs(UnmanagedType.LPWStr)] string servername, uint level, IntPtr buf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetShareDelEx' -Namespace Win32 -PassThru
# $api::NetShareDelEx(servername, level, buf)

#uselib "NETAPI32.dll"
#func global NetShareDelEx "NetShareDelEx" sptr, sptr, sptr
; NetShareDelEx servername, level, varptr(buf)   ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; level : DWORD -> "sptr"
; buf : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NETAPI32.dll"
#cfunc global NetShareDelEx "NetShareDelEx" wstr, int, var
; res = NetShareDelEx(servername, level, buf)
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; buf : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NETAPI32.dll"
#cfunc global NetShareDelEx "NetShareDelEx" wstr, int, sptr
; res = NetShareDelEx(servername, level, varptr(buf))
; servername : LPWSTR optional -> "wstr"
; level : DWORD -> "int"
; buf : BYTE* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。