ホーム › NetworkManagement.NetManagement › NetServerGetInfo

NetServerGetInfo

関数

指定したサーバーの構成情報を取得する。

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

シグネチャ

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

DWORD NetServerGetInfo(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr
);

パラメーター

名前

型

方向

説明

servername

LPWSTR

inoptional

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

level

DWORD

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

値	意味
100	サーバー名とプラットフォーム情報を返します。bufptr パラメーターは SERVER_INFO_100 構造体を指します。
101	サーバー名、種類、および関連付けられたソフトウェアを返します。bufptr パラメーターは SERVER_INFO_101 構造体を指します。
102	サーバー名、種類、関連付けられたソフトウェア、およびその他の属性を返します。bufptr パラメーターは SERVER_INFO_102 構造体を指します。

bufptr

BYTE**

out

データを受け取るバッファーへのポインター。このデータの形式は level パラメーターの値によって異なります。

このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。

戻り値の型: DWORD

公式ドキュメント

NetServerGetInfo 関数は、指定したサーバーの現在の構成情報を取得します。

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED 5	ユーザーは要求された情報へのアクセス権を持っていません。
ERROR_INVALID_LEVEL 124	level パラメーターに指定された値が無効です。
ERROR_INVALID_PARAMETER 87	指定されたパラメーターが無効です。
ERROR_NOT_ENOUGH_MEMORY 8	使用可能なメモリが不足しています。
NERR_ServerNotStarted 2114	Server サービスが開始されていません。

解説(Remarks)

レベル 102 で NetServerGetInfo 関数を正常に実行できるのは、Administrators または Server Operators ローカルグループ、あるいは Print Operator または Server Operator グループのメンバーシップを持つユーザーのみです。レベル 100 またはレベル 101 の呼び出しには、特別なグループメンバーシップは必要ありません。

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

例

次のコードサンプルは、NetServerGetInfo 関数の呼び出しを使用して、サーバーの現在の構成情報を取得する方法を示しています。このサンプルでは、情報レベル 101 (SERVER_INFO_101) を指定して NetServerGetInfo を呼び出します。呼び出しが成功すると、コードはサーバーの種類を特定しようとします。最後に、サンプルは情報バッファー用に割り当てられたメモリを解放します。

#ifndef UNICODE
#define UNICODE
#endif
#pragma comment(lib, "netapi32.lib")

#include <stdio.h>
#include <windows.h> 
#include <lm.h>

int wmain(int argc, wchar_t *argv[])
{
   DWORD dwLevel = 101;
   LPSERVER_INFO_101 pBuf = NULL;
   NET_API_STATUS nStatus;
   LPTSTR pszServerName = NULL;

   if (argc > 2)
   {
      fwprintf(stderr, L"Usage: %s [\\\\ServerName]\n", argv[0]);
      exit(1);
   }
   // The server is not the default local computer.
   //
   if (argc == 2)
      pszServerName = (LPTSTR) argv[1];
   //
   // Call the NetServerGetInfo function, specifying level 101.
   //
   nStatus = NetServerGetInfo(pszServerName,
                              dwLevel,
                              (LPBYTE *)&pBuf);
   //
   // If the call succeeds,
   //
   if (nStatus == NERR_Success)
   {
      //
      // Check for the type of server.
      //
      if ((pBuf->sv101_type & SV_TYPE_DOMAIN_CTRL) ||
         (pBuf->sv101_type & SV_TYPE_DOMAIN_BAKCTRL) ||
         (pBuf->sv101_type & SV_TYPE_SERVER_NT))
         printf("This is a server\n");
      else
         printf("This is a workstation\n");
   }
   //
   // Otherwise, print the system error.
   //
   else
      fprintf(stderr, "A system error has occurred: %d\n", nStatus);
   //
   // Free the allocated memory.
   //
   if (pBuf != NULL)
      NetApiBufferFree(pBuf);

   return 0;
}

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

各言語での呼び出し定義

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

DWORD NetServerGetInfo(
    LPWSTR servername,   // optional
    DWORD level,
    BYTE** bufptr
);

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

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

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

import ctypes
from ctypes import wintypes

NetServerGetInfo = ctypes.windll.netapi32.NetServerGetInfo
NetServerGetInfo.restype = wintypes.DWORD
NetServerGetInfo.argtypes = [
    wintypes.LPCWSTR,  # servername : LPWSTR optional
    wintypes.DWORD,  # level : DWORD
    ctypes.c_void_p,  # bufptr : BYTE** out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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