NetShareAdd

関数

サーバーに新しい共有リソースを追加する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

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

level

DWORD

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

値	意味
2	共有リソースに関する情報を指定します。リソース名、種類とアクセス許可、接続数が含まれます。buf パラメーターは SHARE_INFO_2 構造体を指します。
502	共有リソースに関する情報を指定します。リソース名、種類とアクセス許可、接続数、その他の関連情報が含まれます。buf パラメーターは SHARE_INFO_502 構造体を指します。
503	共有リソースに関する情報を指定します。リソース名、種類とアクセス許可、接続数、その他の関連情報が含まれます。buf パラメーターは SHARE_INFO_503 構造体を指します。

buf

BYTE*

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

parm_err

DWORD*

outoptional

ERROR_INVALID_PARAMETER エラーの原因となった共有情報構造体の最初のメンバーのインデックスを受け取る値へのポインターです。このパラメーターが NULL の場合、エラー時にインデックスは返されません。詳細については、 NetShareSetInfo 関数を参照してください。

戻り値の型: DWORD

公式ドキュメント

サーバーのリソースを共有します。

戻り値

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	ユーザーが要求された情報にアクセスできません。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_INVALID_NAME	文字またはファイルシステム名が無効です。
ERROR_INVALID_PARAMETER	指定されたパラメーターが無効です。
NERR_DuplicateShare	共有名はこのサーバーで既に使用されています。
NERR_RedirectedPath	この操作はリダイレクトされたリソースに対しては無効です。指定されたデバイス名は共有リソースに割り当てられています。
NERR_UnknownDevDir	デバイスまたはディレクトリが存在しません。

解説(Remarks)

この関数は Server Message Block (SMB) 共有にのみ適用されます。Distributed File System (DFS) や WebDAV 共有などの他の種類の共有には、すべての種類の共有をサポートする Windows ネットワーク (WNet) 関数を使用してください。

ファイル共有を NetShareAdd 関数の呼び出しで追加できるのは、Administrators、System Operators、または Power Users ローカルグループのメンバーのみです。Print 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 フラグを指定しておく必要があります。

例

次のコードサンプルは、NetShareAdd 関数の呼び出しを使用してネットワークリソースを共有する方法を示します。このコードサンプルは、SHARE_INFO_2 構造体のメンバーを設定し、情報レベル 2 を指定して NetShareAdd を呼び出します。これらのプラットフォームは共有レベルのセキュリティをサポートしないため、パスワードは不要です。

#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;
   SHARE_INFO_2 p;
   DWORD parm_err = 0;

   if(argc<2)
      printf("Usage: NetShareAdd server\n");
   else
   {
      //
      // Fill in the SHARE_INFO_2 structure.
      //
      p.shi2_netname = TEXT("TESTSHARE");    
      p.shi2_type = STYPE_DISKTREE; // disk drive
      p.shi2_remark = TEXT("TESTSHARE to test NetShareAdd");
      p.shi2_permissions = 0;    
      p.shi2_max_uses = 4;
      p.shi2_current_uses = 0;    
      p.shi2_path = TEXT("C:\\");
      p.shi2_passwd = NULL; // no password
      //
      // Call the NetShareAdd function,
      //  specifying level 2.
      //
      res=NetShareAdd(argv[1], 2, (LPBYTE) &p, &parm_err);
      //
      // If the call succeeds, inform the user.
      //
      if(res==0)
         printf("Share created.\n");
      
      // Otherwise, print an error,
      //  and identify the parameter in error.
      //
      else
         printf("Error: %u\tparmerr=%u\n", res, parm_err);
   }
   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 NetShareAdd(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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