Win32 API 日本語リファレンス
ホームNetworkManagement.NetManagement › NetGetJoinInformation

NetGetJoinInformation

関数
コンピューターの参加状態とワークグループまたはドメイン名を取得する。
DLLNETAPI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD NetGetJoinInformation(
    LPCWSTR lpServer,   // optional
    LPWSTR* lpNameBuffer,
    NETSETUP_JOIN_STATUS* BufferType
);

パラメーター

名前方向説明
lpServerLPCWSTRinoptional関数を呼び出す対象コンピューターの DNS 名または NetBIOS 名を指定する定数文字列へのポインターです。このパラメーターが NULL の場合は、ローカルコンピューターが使用されます。
lpNameBufferLPWSTR*outコンピューターが参加しているドメインまたはワークグループの NetBIOS 名を受け取るバッファーへのポインターです。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、 Network Management Function Buffers および Network Management Function Buffer Lengths を参照してください。
BufferTypeNETSETUP_JOIN_STATUS*out

指定したコンピューターの参加状態を受け取ります。このパラメーターには、次のいずれかの値を指定できます。

typedef enum _NETSETUP_JOIN_STATUS {

    NetSetupUnknownStatus = 0,
    NetSetupUnjoined,
    NetSetupWorkgroupName,
    NetSetupDomainName

} NETSETUP_JOIN_STATUS, *PNETSETUP_JOIN_STATUS;

これらの値の意味は次のとおりです。

意味
NetSetupUnknownStatus
状態は不明です。
NetSetupUnjoined
コンピューターはどこにも参加していません。
NetSetupWorkgroupName
コンピューターはワークグループに参加しています。
NetSetupDomainName
コンピューターはドメインに参加しています。

戻り値の型: DWORD

公式ドキュメント

NetGetJoinInformation 関数は、指定したコンピューターの参加状態に関する情報を取得します。

戻り値

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

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

戻りコード 説明
ERROR_NOT_ENOUGH_MEMORY
このコマンドを処理するのに十分な記憶域がありません。

解説(Remarks)

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

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

各言語での呼び出し定義

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

DWORD NetGetJoinInformation(
    LPCWSTR lpServer,   // optional
    LPWSTR* lpNameBuffer,
    NETSETUP_JOIN_STATUS* BufferType
);
[DllImport("NETAPI32.dll", ExactSpelling = true)]
static extern uint NetGetJoinInformation(
    [MarshalAs(UnmanagedType.LPWStr)] string lpServer,   // LPCWSTR optional
    IntPtr lpNameBuffer,   // LPWSTR* out
    out int BufferType   // NETSETUP_JOIN_STATUS* out
);
<DllImport("NETAPI32.dll", ExactSpelling:=True)>
Public Shared Function NetGetJoinInformation(
    <MarshalAs(UnmanagedType.LPWStr)> lpServer As String,   ' LPCWSTR optional
    lpNameBuffer As IntPtr,   ' LPWSTR* out
    <Out> ByRef BufferType As Integer   ' NETSETUP_JOIN_STATUS* out
) As UInteger
End Function
' lpServer : LPCWSTR optional
' lpNameBuffer : LPWSTR* out
' BufferType : NETSETUP_JOIN_STATUS* out
Declare PtrSafe Function NetGetJoinInformation Lib "netapi32" ( _
    ByVal lpServer As LongPtr, _
    ByVal lpNameBuffer As LongPtr, _
    ByRef BufferType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NetGetJoinInformation = ctypes.windll.netapi32.NetGetJoinInformation
NetGetJoinInformation.restype = wintypes.DWORD
NetGetJoinInformation.argtypes = [
    wintypes.LPCWSTR,  # lpServer : LPCWSTR optional
    ctypes.c_void_p,  # lpNameBuffer : LPWSTR* out
    ctypes.c_void_p,  # BufferType : NETSETUP_JOIN_STATUS* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
NetGetJoinInformation = Fiddle::Function.new(
  lib['NetGetJoinInformation'],
  [
    Fiddle::TYPE_VOIDP,  # lpServer : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpNameBuffer : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # BufferType : NETSETUP_JOIN_STATUS* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn NetGetJoinInformation(
        lpServer: *const u16,  // LPCWSTR optional
        lpNameBuffer: *mut *mut u16,  // LPWSTR* out
        BufferType: *mut i32  // NETSETUP_JOIN_STATUS* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll")]
public static extern uint NetGetJoinInformation([MarshalAs(UnmanagedType.LPWStr)] string lpServer, IntPtr lpNameBuffer, out int BufferType);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_NetGetJoinInformation' -Namespace Win32 -PassThru
# $api::NetGetJoinInformation(lpServer, lpNameBuffer, BufferType)
#uselib "NETAPI32.dll"
#func global NetGetJoinInformation "NetGetJoinInformation" sptr, sptr, sptr
; NetGetJoinInformation lpServer, varptr(lpNameBuffer), varptr(BufferType)   ; 戻り値は stat
; lpServer : LPCWSTR optional -> "sptr"
; lpNameBuffer : LPWSTR* out -> "sptr"
; BufferType : NETSETUP_JOIN_STATUS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global NetGetJoinInformation "NetGetJoinInformation" wstr, var, var
; res = NetGetJoinInformation(lpServer, lpNameBuffer, BufferType)
; lpServer : LPCWSTR optional -> "wstr"
; lpNameBuffer : LPWSTR* out -> "var"
; BufferType : NETSETUP_JOIN_STATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD NetGetJoinInformation(LPCWSTR lpServer, LPWSTR* lpNameBuffer, NETSETUP_JOIN_STATUS* BufferType)
#uselib "NETAPI32.dll"
#cfunc global NetGetJoinInformation "NetGetJoinInformation" wstr, var, var
; res = NetGetJoinInformation(lpServer, lpNameBuffer, BufferType)
; lpServer : LPCWSTR optional -> "wstr"
; lpNameBuffer : LPWSTR* out -> "var"
; BufferType : NETSETUP_JOIN_STATUS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procNetGetJoinInformation = netapi32.NewProc("NetGetJoinInformation")
)

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

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

typedef NetGetJoinInformationNative = Uint32 Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Int32>);
typedef NetGetJoinInformationDart = int Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Int32>);
final NetGetJoinInformation = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<NetGetJoinInformationNative, NetGetJoinInformationDart>('NetGetJoinInformation');
// lpServer : LPCWSTR optional -> Pointer<Utf16>
// lpNameBuffer : LPWSTR* out -> Pointer<Pointer<Utf16>>
// BufferType : NETSETUP_JOIN_STATUS* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function NetGetJoinInformation(
  lpServer: PWideChar;   // LPCWSTR optional
  lpNameBuffer: PPWideChar;   // LPWSTR* out
  BufferType: Pointer   // NETSETUP_JOIN_STATUS* out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'NetGetJoinInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NetGetJoinInformation"
  c_NetGetJoinInformation :: CWString -> Ptr CWString -> Ptr Int32 -> IO Word32
-- lpServer : LPCWSTR optional -> CWString
-- lpNameBuffer : LPWSTR* out -> Ptr CWString
-- BufferType : NETSETUP_JOIN_STATUS* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let netgetjoininformation =
  foreign "NetGetJoinInformation"
    ((ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> (ptr int32_t) @-> returning uint32_t)
(* lpServer : LPCWSTR optional -> (ptr uint16_t) *)
(* lpNameBuffer : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* BufferType : NETSETUP_JOIN_STATUS* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("NetGetJoinInformation" net-get-join-information :convention :stdcall) :uint32
  (lp-server (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-name-buffer :pointer)   ; LPWSTR* out
  (buffer-type :pointer))   ; NETSETUP_JOIN_STATUS* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NetGetJoinInformation = Win32::API::More->new('NETAPI32',
    'DWORD NetGetJoinInformation(LPCWSTR lpServer, LPVOID lpNameBuffer, LPVOID BufferType)');
# my $ret = $NetGetJoinInformation->Call($lpServer, $lpNameBuffer, $BufferType);
# lpServer : LPCWSTR optional -> LPCWSTR
# lpNameBuffer : LPWSTR* out -> LPVOID
# BufferType : NETSETUP_JOIN_STATUS* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型