Win32 API 日本語リファレンス
ホームStorage.FileSystem › NetShareDel

NetShareDel

関数
サーバーから共有リソースを削除する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NetShareDel(
    LPWSTR servername,   // optional
    LPWSTR netname,
    DWORD reserved   // optional
);

パラメーター

名前方向説明
servernameLPWSTRinoptional

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

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

netnameLPWSTRin

削除する共有の名前を指定する文字列へのポインターです。

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

reservedDWORDoptional予約済みです。0 を指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
ユーザーが要求された情報へのアクセス権を持っていません。
ERROR_INVALID_PARAMETER
指定されたパラメーターが無効です。
ERROR_NOT_ENOUGH_MEMORY
使用可能なメモリが不足しています。
NERR_NetNameNotFound
共有名が存在しません。

解説(Remarks)

この関数は Server Message Block (SMB) 共有にのみ適用されます。分散ファイルシステム (DFS) や WebDAV 共有などの他の種類の共有については、すべての種類の共有をサポートする Windows ネットワーク (WNet) 関数 を使用してください。

NetShareDel 関数の呼び出しによってファイル共有を正常に削除できるのは、Administrators、Server Operators、または Power Users ローカルグループのメンバー、もしくは Server Operator グループのメンバーシップを持つユーザーのみです。Print Operator はプリンター共有を削除できます。

Active Directory 向けにプログラミングしている場合、特定の Active Directory Service Interface (ADSI) メソッドを呼び出すことで、ネットワーク管理の共有関数を呼び出して実現できるのと同じ機能を実現できることがあります。詳細については、 IADsFileShare を参照してください。

次のコードサンプルは、NetShareDel 関数の呼び出しを使用して共有を削除する方法を示しています。

#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <stdio.h>
#include <lm.h>
#pragma comment(lib, "Netapi32.lib")

void wmain( int argc, TCHAR *argv[ ])
{
   NET_API_STATUS res;

   if(argc<3)
      printf("Usage: NetShareDel server share\n");
   else
   {
      //
      // Call the NetShareDel function to delete the share.
      //
      res=NetShareDel(argv[1], argv[2], 0);
      //
      // Display the result of the call.
      //
      if(res==0)
         printf("Share Removed.\n");
      else
         printf("Error: %u\n", res);
   }
   return;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD NetShareDel(
    LPWSTR servername,   // optional
    LPWSTR netname,
    DWORD reserved   // optional
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetShareDel(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string netname,   // LPWSTR
    uint reserved   // DWORD optional
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetShareDel(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> netname As String,   ' LPWSTR
    reserved As UInteger   ' DWORD optional
) As UInteger
End Function
' servername : LPWSTR optional
' netname : LPWSTR
' reserved : DWORD optional
Declare PtrSafe Function NetShareDel Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal netname As LongPtr, _
    ByVal reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetShareDel = ctypes.windll.netapi32.NetShareDel
NetShareDel.restype = wintypes.DWORD
NetShareDel.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.LPCWSTR,  # netname : LPWSTR
    wintypes.DWORD,  # reserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetShareDel = Fiddle::Function.new(
  lib['NetShareDel'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # netname : LPWSTR
    -Fiddle::TYPE_INT,  # reserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetShareDel(
        servername: *mut u16,  // LPWSTR optional
        netname: *mut u16,  // LPWSTR
        reserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetShareDel([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string netname, uint reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetShareDel' -Namespace Win32 -PassThru
# $api::NetShareDel(servername, netname, reserved)
#uselib "NETAPI32.dll"
#func global NetShareDel "NetShareDel" sptr, sptr, sptr
; NetShareDel servername, netname, reserved   ; 戻り値は stat
; servername : LPWSTR optional -> "sptr"
; netname : LPWSTR -> "sptr"
; reserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NETAPI32.dll"
#cfunc global NetShareDel "NetShareDel" wstr, wstr, int
; res = NetShareDel(servername, netname, reserved)
; servername : LPWSTR optional -> "wstr"
; netname : LPWSTR -> "wstr"
; reserved : DWORD optional -> "int"
; DWORD NetShareDel(LPWSTR servername, LPWSTR netname, DWORD reserved)
#uselib "NETAPI32.dll"
#cfunc global NetShareDel "NetShareDel" wstr, wstr, int
; res = NetShareDel(servername, netname, reserved)
; servername : LPWSTR optional -> "wstr"
; netname : LPWSTR -> "wstr"
; reserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetShareDel = netapi32.NewProc("NetShareDel")
)

// servername (LPWSTR optional), netname (LPWSTR), reserved (DWORD optional)
r1, _, err := procNetShareDel.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(servername))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(netname))),
	uintptr(reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function NetShareDel(
  servername: PWideChar;   // LPWSTR optional
  netname: PWideChar;   // LPWSTR
  reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetShareDel';
result := DllCall("NETAPI32\NetShareDel"
    , "WStr", servername   ; LPWSTR optional
    , "WStr", netname   ; LPWSTR
    , "UInt", reserved   ; DWORD optional
    , "UInt")   ; return: DWORD
●NetShareDel(servername, netname, reserved) = DLL("NETAPI32.dll", "dword NetShareDel(char*, char*, dword)")
# 呼び出し: NetShareDel(servername, netname, reserved)
# servername : LPWSTR optional -> "char*"
# netname : LPWSTR -> "char*"
# reserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn NetShareDel(
    servername: [*c]const u16, // LPWSTR optional
    netname: [*c]const u16, // LPWSTR
    reserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;
proc NetShareDel(
    servername: WideCString,  # LPWSTR optional
    netname: WideCString,  # LPWSTR
    reserved: uint32  # DWORD optional
): uint32 {.importc: "NetShareDel", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint NetShareDel(
    const(wchar)* servername,   // LPWSTR optional
    const(wchar)* netname,   // LPWSTR
    uint reserved   // DWORD optional
);
ccall((:NetShareDel, "NETAPI32.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, UInt32),
      servername, netname, reserved)
# servername : LPWSTR optional -> Cwstring
# netname : LPWSTR -> Cwstring
# reserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t NetShareDel(
    const uint16_t* servername,
    const uint16_t* netname,
    uint32_t reserved);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.NetShareDel(servername, netname, reserved)
-- servername : LPWSTR optional
-- netname : LPWSTR
-- reserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const NetShareDel = lib.func('__stdcall', 'NetShareDel', 'uint32_t', ['str16', 'str16', 'uint32_t']);
// NetShareDel(servername, netname, reserved)
// servername : LPWSTR optional -> 'str16'
// netname : LPWSTR -> 'str16'
// reserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  NetShareDel: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.NetShareDel(servername, netname, reserved)
// servername : LPWSTR optional -> "buffer"
// netname : LPWSTR -> "buffer"
// reserved : DWORD optional -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t NetShareDel(
    const uint16_t* servername,
    const uint16_t* netname,
    uint32_t reserved);
C, "NETAPI32.dll");
// $ffi->NetShareDel(servername, netname, reserved);
// servername : LPWSTR optional
// netname : LPWSTR
// reserved : DWORD optional
// 構造体/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 NetShareDel(
        WString servername,   // LPWSTR optional
        WString netname,   // LPWSTR
        int reserved   // DWORD optional
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun NetShareDel = NetShareDel(
    servername : UInt16*,   # LPWSTR optional
    netname : UInt16*,   # LPWSTR
    reserved : UInt32   # DWORD optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NetShareDelNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef NetShareDelDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final NetShareDel = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetShareDelNative, NetShareDelDart>('NetShareDel');
// servername : LPWSTR optional -> Pointer<Utf16>
// netname : LPWSTR -> Pointer<Utf16>
// reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetShareDel(
  servername: PWideChar;   // LPWSTR optional
  netname: PWideChar;   // LPWSTR
  reserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetShareDel';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetShareDel"
  c_NetShareDel :: CWString -> CWString -> Word32 -> IO Word32
-- servername : LPWSTR optional -> CWString
-- netname : LPWSTR -> CWString
-- reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netsharedel =
  foreign "NetShareDel"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* servername : LPWSTR optional -> (ptr uint16_t) *)
(* netname : LPWSTR -> (ptr uint16_t) *)
(* reserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetShareDel" net-share-del :convention :stdcall) :uint32
  (servername (:string :encoding :utf-16le))   ; LPWSTR optional
  (netname (:string :encoding :utf-16le))   ; LPWSTR
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetShareDel = Win32::API::More->new('NETAPI32',
    'DWORD NetShareDel(LPCWSTR servername, LPCWSTR netname, DWORD reserved)');
# my $ret = $NetShareDel->Call($servername, $netname, $reserved);
# servername : LPWSTR optional -> LPCWSTR
# netname : LPWSTR -> LPCWSTR
# reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目