ホーム › Storage.FileSystem › NetShareSetInfo

NetShareSetInfo

関数

指定した共有リソースの情報を設定する。

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

シグネチャ

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

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

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

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

netname

LPWSTR

情報を設定する共有の名前を指定する文字列へのポインター。

level

DWORD

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

値	意味
1	共有リソースに関する情報を指定します。これには、リソースの名前と種類、およびリソースに関連付けられたコメントが含まれます。buf パラメーターは SHARE_INFO_1 構造体を指します。
2	共有リソースに関する情報を指定します。これには、リソースの名前、種類とアクセス許可、パスワード、および接続数が含まれます。buf パラメーターは SHARE_INFO_2 構造体を指します。
502	共有リソースに関する情報を指定します。これには、リソースの名前と種類、必要なアクセス許可、接続数、その他の関連情報が含まれます。buf パラメーターは SHARE_INFO_502 構造体を指します。
503	共有リソースの名前を指定します。buf パラメーターは SHARE_INFO_503 構造体を指します。この構造体のメンバーのうち shi503_servername 以外はすべて、NetShareSetInfo 関数によって無視されます。 Windows Server 2003 および Windows XP: この情報レベルはサポートされていません。
1004	共有リソースに関連付けられたコメントを指定します。buf パラメーターは SHARE_INFO_1004 構造体を指します。
1005	共有リソースを記述する一連のフラグを指定します。buf パラメーターは SHARE_INFO_1005 構造体を指します。
1006	共有リソースが受け入れることのできる同時接続の最大数を指定します。buf パラメーターは SHARE_INFO_1006 構造体を指します。
1501	指定された共有に関連付けられた SECURITY_DESCRIPTOR を指定します。buf パラメーターは SHARE_INFO_1501 構造体を指します。

buf

BYTE*

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

parm_err

DWORD*

outoptional

ERROR_INVALID_PARAMETER エラーを引き起こした共有情報構造体の最初のメンバーのインデックスを受け取る値へのポインター。このパラメーターが NULL の場合、エラー時にインデックスは返されません。詳細については、後述の「注釈」セクションを参照してください。

戻り値の型: DWORD

公式ドキュメント

共有リソースのパラメーターを設定します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL	level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER	指定されたパラメーターが無効です。詳細については、後述の「注釈」セクションを参照してください。
NERR_NetNameNotFound	共有名が存在しません。

解説(Remarks)

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

NetShareSetInfo 関数を正常に実行できるのは、Administrators または Power Users ローカルグループのメンバー、あるいは Print Operator または Server Operator グループのメンバーのみです。Print Operator は、プリンター共有に関する情報のみを設定できます。

NetShareSetInfo 関数が ERROR_INVALID_PARAMETER を返した場合、parm_err パラメーターを使用して、無効である共有情報構造体の最初のメンバーを特定できます。(共有情報構造体は SHARE_INFO_ で始まり、その形式は level パラメーターによって指定されます。)次の表は、parm_err パラメーターで返される可能性のある値と、それに対応するエラーの原因となる構造体メンバーを示しています。(プレフィックス shi*_ は、メンバーが複数のプレフィックスで始まる可能性があることを示します。たとえば、shi2_ や shi502_ です。)

値	メンバー
SHARE_NETNAME_PARMNUM	*shi_netname**
SHARE_TYPE_PARMNUM	*shi_type**
SHARE_REMARK_PARMNUM	*shi_remark**
SHARE_PERMISSIONS_PARMNUM	*shi_permissions**
SHARE_MAX_USES_PARMNUM	*shi_max_uses**
SHARE_CURRENT_USES_PARMNUM	*shi_current_uses**
SHARE_PATH_PARMNUM	*shi_path**
SHARE_PASSWD_PARMNUM	*shi_passwd**
SHARE_FILE_SD_PARMNUM	*shi_security_descriptor**

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 フラグを指定する必要があります。

例

次のコードサンプルは、NetShareSetInfo 関数の呼び出しを使用して共有リソースに関連付けられたコメントを設定する方法を示しています。これを行うために、サンプルでは情報レベル 1004 (SHARE_INFO_1004) を指定しています。

#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[ ])
{
   SHARE_INFO_1004 p;
   NET_API_STATUS res;
   DWORD parm_err = 0;

   if(argc<4)
      printf("Usage: SetInfo server share \"remark\"\n");
   else
   {
      //
      // Fill in SHARE_INFO_1004 structure member.
      //
      p.shi1004_remark=argv[3];
      //
      // Call the NetShareSetInfo function,
      //  specifying information level 1004.
      //
      res=NetShareSetInfo(argv[1], argv[2], 1004, (LPBYTE)&p, &parm_err);
      //
      // Display the result of the call.
      //
      if(res==0)
         printf("Remark set.\n");
      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 NetShareSetInfo(
    LPWSTR servername,   // optional
    LPWSTR netname,
    DWORD level,
    BYTE* buf,
    DWORD* parm_err   // optional
);

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

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

' servername : LPWSTR optional
' netname : LPWSTR
' level : DWORD
' buf : BYTE*
' parm_err : DWORD* optional, out
Declare PtrSafe Function NetShareSetInfo Lib "netapi32" ( _
    ByVal servername As LongPtr, _
    ByVal netname 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

NetShareSetInfo = ctypes.windll.netapi32.NetShareSetInfo
NetShareSetInfo.restype = wintypes.DWORD
NetShareSetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.LPCWSTR,  # netname : LPWSTR
    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')
NetShareSetInfo = Fiddle::Function.new(
  lib['NetShareSetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # netname : LPWSTR
    -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 NetShareSetInfo(
        servername: *mut u16,  // LPWSTR optional
        netname: *mut u16,  // LPWSTR
        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 NetShareSetInfo([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string netname, uint level, IntPtr buf, IntPtr parm_err);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetShareSetInfo' -Namespace Win32 -PassThru
# $api::NetShareSetInfo(servername, netname, level, buf, parm_err)

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

出力引数:

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