ホーム › Storage.FileSystem › NetShareCheck

NetShareCheck

関数

デバイスが共有されているかどうかを確認する。

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

シグネチャ

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

DWORD NetShareCheck(
    LPWSTR servername,   // optional
    LPWSTR device,
    DWORD* type
);

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

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

device

LPWSTR

共有アクセスを確認するデバイスの名前を指定する文字列へのポインターです。

type

DWORD*

out

共有デバイスの種類を指定するフラグのビットマスクを受け取る変数へのポインターです。このパラメーターは、関数が正常に終了した場合にのみ設定されます。

次のいずれかのフラグが指定される場合があります。

値	意味
STYPE_DISKTREE	ディスクドライブ。
STYPE_PRINTQ	印刷キュー。
STYPE_DEVICE	通信デバイス。
STYPE_IPC	プロセス間通信 (IPC)。

さらに、次のフラグの一方または両方が指定される場合があります。

値	意味
STYPE_SPECIAL	プロセス間通信 (IPC$) またはサーバーのリモート管理 (ADMIN$) のために予約された特殊な共有です。C$、D$、E$ などの管理共有を指す場合もあります。詳細については、ネットワーク共有関数を参照してください。
STYPE_TEMPORARY	一時的な共有。

戻り値の型: DWORD

公式ドキュメント

サーバーがデバイスを共有しているかどうかを確認します。

戻り値

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

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

戻りコード	説明
ERROR_NOT_ENOUGH_MEMORY	使用可能なメモリが不足しています。
NERR_DeviceNotShared	デバイスは共有されていません。

解説(Remarks)

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

NetShareCheck 関数を正常に実行するために、特別なグループメンバーシップは必要ありません。

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

例

次のコードサンプルは、NetShareCheck 関数の呼び出しを使用して、サーバーがデバイスを共有しているかどうかを確認する方法を示しています。この関数は、前述の type パラメーターのドキュメントで説明されているように、共有されているデバイスの種類を返します。

#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;
   DWORD devType = 0;

   if(argc<3)
      printf("Usage: NetShareCheck server device\n");
   else
   {
      //
      // Call the NetShareCheck function.
      //
      res=NetShareCheck(argv[1], argv[2], &devType);
      //
      // If the function succeeds, inform the user.
      //
      if(res==0)
         printf("Device is shared as type %u.\n",devType);
      //
      // Otherwise, print the error.
      //
      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 NetShareCheck(
    LPWSTR servername,   // optional
    LPWSTR device,
    DWORD* type
);

[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetShareCheck(
    [MarshalAs(UnmanagedType.LPWStr)] string servername,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string device,   // LPWSTR
    out uint type   // DWORD* out
);

<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetShareCheck(
    <MarshalAs(UnmanagedType.LPWStr)> servername As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> device As String,   ' LPWSTR
    <Out> ByRef type As UInteger   ' DWORD* out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

NetShareCheck = ctypes.windll.netapi32.NetShareCheck
NetShareCheck.restype = wintypes.DWORD
NetShareCheck.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.LPCWSTR,  # device : LPWSTR
    ctypes.POINTER(wintypes.DWORD),  # type : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetShareCheck = Fiddle::Function.new(
  lib['NetShareCheck'],
  [
    Fiddle::TYPE_VOIDP,  # servername : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # device : LPWSTR
    Fiddle::TYPE_VOIDP,  # type : DWORD* out
  ],
  -Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetShareCheck([MarshalAs(UnmanagedType.LPWStr)] string servername, [MarshalAs(UnmanagedType.LPWStr)] string device, out uint type);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetShareCheck' -Namespace Win32 -PassThru
# $api::NetShareCheck(servername, device, type)

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

出力引数:

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