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

SetSessionCompartmentId

関数
指定したセッションにコンパートメントIDを設定する。
DLLIPHLPAPI.dll呼出規約winapi

シグネチャ

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

WIN32_ERROR SetSessionCompartmentId(
    DWORD SessionId,
    NET_IF_COMPARTMENT_ID CompartmentId
);

パラメーター

名前方向説明
SessionIdDWORDin予約済みです。
CompartmentIdNET_IF_COMPARTMENT_IDin予約済みです。

戻り値の型: WIN32_ERROR

公式ドキュメント

将来の使用のために予約されています。この関数は使用しないでください。(SetSessionCompartmentId)

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

各言語での呼び出し定義

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

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

SetSessionCompartmentId = ctypes.windll.iphlpapi.SetSessionCompartmentId
SetSessionCompartmentId.restype = wintypes.DWORD
SetSessionCompartmentId.argtypes = [
    wintypes.DWORD,  # SessionId : DWORD
    wintypes.DWORD,  # CompartmentId : NET_IF_COMPARTMENT_ID
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetSessionCompartmentId = iphlpapi.NewProc("SetSessionCompartmentId")
)

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

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

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

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

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

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

関連項目

使用する型