Win32 API 日本語リファレンス
ホームSystem.Environment › CreateEnvironmentBlock

CreateEnvironmentBlock

関数
指定ユーザートークンに基づく環境ブロックを作成する。
DLLUSERENV.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL CreateEnvironmentBlock(
    void** lpEnvironment,
    HANDLE hToken,   // optional
    BOOL bInherit
);

パラメーター

名前方向説明
lpEnvironmentvoid**out作成された環境ブロックへのポインタを受け取る出力ポインタ。
hTokenHANDLEinoptional対象ユーザーのアクセストークン。NULLで現在のプロセス環境を使う。
bInheritBOOLin現在のプロセスの環境を継承するかどうかを示すブール値。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL CreateEnvironmentBlock(
    void** lpEnvironment,
    HANDLE hToken,   // optional
    BOOL bInherit
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CreateEnvironmentBlock(
    IntPtr lpEnvironment,   // void** out
    IntPtr hToken,   // HANDLE optional
    bool bInherit   // BOOL
);
<DllImport("USERENV.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateEnvironmentBlock(
    lpEnvironment As IntPtr,   ' void** out
    hToken As IntPtr,   ' HANDLE optional
    bInherit As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpEnvironment : void** out
' hToken : HANDLE optional
' bInherit : BOOL
Declare PtrSafe Function CreateEnvironmentBlock Lib "userenv" ( _
    ByVal lpEnvironment As LongPtr, _
    ByVal hToken As LongPtr, _
    ByVal bInherit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateEnvironmentBlock = ctypes.windll.userenv.CreateEnvironmentBlock
CreateEnvironmentBlock.restype = wintypes.BOOL
CreateEnvironmentBlock.argtypes = [
    ctypes.c_void_p,  # lpEnvironment : void** out
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.BOOL,  # bInherit : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
CreateEnvironmentBlock = Fiddle::Function.new(
  lib['CreateEnvironmentBlock'],
  [
    Fiddle::TYPE_VOIDP,  # lpEnvironment : void** out
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_INT,  # bInherit : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "userenv")]
extern "system" {
    fn CreateEnvironmentBlock(
        lpEnvironment: *mut *mut (),  // void** out
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        bInherit: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true)]
public static extern bool CreateEnvironmentBlock(IntPtr lpEnvironment, IntPtr hToken, bool bInherit);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_CreateEnvironmentBlock' -Namespace Win32 -PassThru
# $api::CreateEnvironmentBlock(lpEnvironment, hToken, bInherit)
#uselib "USERENV.dll"
#func global CreateEnvironmentBlock "CreateEnvironmentBlock" sptr, sptr, sptr
; CreateEnvironmentBlock lpEnvironment, hToken, bInherit   ; 戻り値は stat
; lpEnvironment : void** out -> "sptr"
; hToken : HANDLE optional -> "sptr"
; bInherit : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USERENV.dll"
#cfunc global CreateEnvironmentBlock "CreateEnvironmentBlock" sptr, sptr, int
; res = CreateEnvironmentBlock(lpEnvironment, hToken, bInherit)
; lpEnvironment : void** out -> "sptr"
; hToken : HANDLE optional -> "sptr"
; bInherit : BOOL -> "int"
; BOOL CreateEnvironmentBlock(void** lpEnvironment, HANDLE hToken, BOOL bInherit)
#uselib "USERENV.dll"
#cfunc global CreateEnvironmentBlock "CreateEnvironmentBlock" intptr, intptr, int
; res = CreateEnvironmentBlock(lpEnvironment, hToken, bInherit)
; lpEnvironment : void** out -> "intptr"
; hToken : HANDLE optional -> "intptr"
; bInherit : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procCreateEnvironmentBlock = userenv.NewProc("CreateEnvironmentBlock")
)

// lpEnvironment (void** out), hToken (HANDLE optional), bInherit (BOOL)
r1, _, err := procCreateEnvironmentBlock.Call(
	uintptr(lpEnvironment),
	uintptr(hToken),
	uintptr(bInherit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function CreateEnvironmentBlock(
  lpEnvironment: Pointer;   // void** out
  hToken: THandle;   // HANDLE optional
  bInherit: BOOL   // BOOL
): BOOL; stdcall;
  external 'USERENV.dll' name 'CreateEnvironmentBlock';
result := DllCall("USERENV\CreateEnvironmentBlock"
    , "Ptr", lpEnvironment   ; void** out
    , "Ptr", hToken   ; HANDLE optional
    , "Int", bInherit   ; BOOL
    , "Int")   ; return: BOOL
●CreateEnvironmentBlock(lpEnvironment, hToken, bInherit) = DLL("USERENV.dll", "bool CreateEnvironmentBlock(void*, void*, bool)")
# 呼び出し: CreateEnvironmentBlock(lpEnvironment, hToken, bInherit)
# lpEnvironment : void** out -> "void*"
# hToken : HANDLE optional -> "void*"
# bInherit : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CreateEnvironmentBlockNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int32);
typedef CreateEnvironmentBlockDart = int Function(Pointer<Void>, Pointer<Void>, int);
final CreateEnvironmentBlock = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<CreateEnvironmentBlockNative, CreateEnvironmentBlockDart>('CreateEnvironmentBlock');
// lpEnvironment : void** out -> Pointer<Void>
// hToken : HANDLE optional -> Pointer<Void>
// bInherit : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateEnvironmentBlock(
  lpEnvironment: Pointer;   // void** out
  hToken: THandle;   // HANDLE optional
  bInherit: BOOL   // BOOL
): BOOL; stdcall;
  external 'USERENV.dll' name 'CreateEnvironmentBlock';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateEnvironmentBlock"
  c_CreateEnvironmentBlock :: Ptr () -> Ptr () -> CInt -> IO CInt
-- lpEnvironment : void** out -> Ptr ()
-- hToken : HANDLE optional -> Ptr ()
-- bInherit : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createenvironmentblock =
  foreign "CreateEnvironmentBlock"
    ((ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* lpEnvironment : void** out -> (ptr void) *)
(* hToken : HANDLE optional -> (ptr void) *)
(* bInherit : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)

(cffi:defcfun ("CreateEnvironmentBlock" create-environment-block :convention :stdcall) :int32
  (lp-environment :pointer)   ; void** out
  (h-token :pointer)   ; HANDLE optional
  (b-inherit :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateEnvironmentBlock = Win32::API::More->new('USERENV',
    'BOOL CreateEnvironmentBlock(LPVOID lpEnvironment, HANDLE hToken, BOOL bInherit)');
# my $ret = $CreateEnvironmentBlock->Call($lpEnvironment, $hToken, $bInherit);
# lpEnvironment : void** out -> LPVOID
# hToken : HANDLE optional -> HANDLE
# bInherit : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。