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

GetDefaultCompartmentId

関数
既定のルーティングコンパートメントIDを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

NET_IF_COMPARTMENT_ID GetDefaultCompartmentId(void);

パラメーターなし。戻り値: NET_IF_COMPARTMENT_ID

公式ドキュメント

GetDefaultCompartmentId 関数は、ローカルコンピューターの既定のネットワークルーティングコンパートメント識別子を取得します。

戻り値

関数が成功した場合、戻り値は既定の Compartment ID です。

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

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

各言語での呼び出し定義

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

NET_IF_COMPARTMENT_ID GetDefaultCompartmentId(void);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetDefaultCompartmentId();
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetDefaultCompartmentId() As UInteger
End Function
Declare PtrSafe Function GetDefaultCompartmentId Lib "iphlpapi" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDefaultCompartmentId = ctypes.windll.iphlpapi.GetDefaultCompartmentId
GetDefaultCompartmentId.restype = wintypes.DWORD
GetDefaultCompartmentId.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetDefaultCompartmentId = Fiddle::Function.new(
  lib['GetDefaultCompartmentId'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetDefaultCompartmentId() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetDefaultCompartmentId();
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetDefaultCompartmentId' -Namespace Win32 -PassThru
# $api::GetDefaultCompartmentId()
#uselib "IPHLPAPI.dll"
#func global GetDefaultCompartmentId "GetDefaultCompartmentId"
; GetDefaultCompartmentId   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IPHLPAPI.dll"
#cfunc global GetDefaultCompartmentId "GetDefaultCompartmentId"
; res = GetDefaultCompartmentId()
; NET_IF_COMPARTMENT_ID GetDefaultCompartmentId()
#uselib "IPHLPAPI.dll"
#cfunc global GetDefaultCompartmentId "GetDefaultCompartmentId"
; res = GetDefaultCompartmentId()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetDefaultCompartmentId = iphlpapi.NewProc("GetDefaultCompartmentId")
)

r1, _, err := procGetDefaultCompartmentId.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // NET_IF_COMPARTMENT_ID
function GetDefaultCompartmentId: DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetDefaultCompartmentId';
result := DllCall("IPHLPAPI\GetDefaultCompartmentId", "UInt")
●GetDefaultCompartmentId() = DLL("IPHLPAPI.dll", "dword GetDefaultCompartmentId()")
# 呼び出し: GetDefaultCompartmentId()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetDefaultCompartmentIdNative = Uint32 Function();
typedef GetDefaultCompartmentIdDart = int Function();
final GetDefaultCompartmentId = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetDefaultCompartmentIdNative, GetDefaultCompartmentIdDart>('GetDefaultCompartmentId');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDefaultCompartmentId: DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetDefaultCompartmentId';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDefaultCompartmentId"
  c_GetDefaultCompartmentId :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdefaultcompartmentid =
  foreign "GetDefaultCompartmentId"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetDefaultCompartmentId" get-default-compartment-id :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDefaultCompartmentId = Win32::API::More->new('IPHLPAPI',
    'DWORD GetDefaultCompartmentId()');
# my $ret = $GetDefaultCompartmentId->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。