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

SetEnvironmentStringsA

関数
ANSI環境ブロック全体を設定する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SetEnvironmentStringsA(
    LPSTR NewEnvironment
);

パラメーター

名前方向説明
NewEnvironmentLPSTRin新たに設定する環境ブロックへのポインタ。NUL区切りの文字列群を二重NULで終端する。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL SetEnvironmentStringsA(
    LPSTR NewEnvironment
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool SetEnvironmentStringsA(
    [MarshalAs(UnmanagedType.LPStr)] string NewEnvironment   // LPSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SetEnvironmentStringsA(
    <MarshalAs(UnmanagedType.LPStr)> NewEnvironment As String   ' LPSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' NewEnvironment : LPSTR
Declare PtrSafe Function SetEnvironmentStringsA Lib "kernel32" ( _
    ByVal NewEnvironment As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetEnvironmentStringsA = ctypes.windll.kernel32.SetEnvironmentStringsA
SetEnvironmentStringsA.restype = wintypes.BOOL
SetEnvironmentStringsA.argtypes = [
    wintypes.LPCSTR,  # NewEnvironment : LPSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetEnvironmentStringsA = Fiddle::Function.new(
  lib['SetEnvironmentStringsA'],
  [
    Fiddle::TYPE_VOIDP,  # NewEnvironment : LPSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetEnvironmentStringsA(
        NewEnvironment: *mut u8  // LPSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern bool SetEnvironmentStringsA([MarshalAs(UnmanagedType.LPStr)] string NewEnvironment);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetEnvironmentStringsA' -Namespace Win32 -PassThru
# $api::SetEnvironmentStringsA(NewEnvironment)
#uselib "KERNEL32.dll"
#func global SetEnvironmentStringsA "SetEnvironmentStringsA" sptr
; SetEnvironmentStringsA NewEnvironment   ; 戻り値は stat
; NewEnvironment : LPSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetEnvironmentStringsA "SetEnvironmentStringsA" str
; res = SetEnvironmentStringsA(NewEnvironment)
; NewEnvironment : LPSTR -> "str"
; BOOL SetEnvironmentStringsA(LPSTR NewEnvironment)
#uselib "KERNEL32.dll"
#cfunc global SetEnvironmentStringsA "SetEnvironmentStringsA" str
; res = SetEnvironmentStringsA(NewEnvironment)
; NewEnvironment : LPSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetEnvironmentStringsA = kernel32.NewProc("SetEnvironmentStringsA")
)

// NewEnvironment (LPSTR)
r1, _, err := procSetEnvironmentStringsA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(NewEnvironment))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetEnvironmentStringsA(
  NewEnvironment: PAnsiChar   // LPSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetEnvironmentStringsA';
result := DllCall("KERNEL32\SetEnvironmentStringsA"
    , "AStr", NewEnvironment   ; LPSTR
    , "Int")   ; return: BOOL
●SetEnvironmentStringsA(NewEnvironment) = DLL("KERNEL32.dll", "bool SetEnvironmentStringsA(char*)")
# 呼び出し: SetEnvironmentStringsA(NewEnvironment)
# NewEnvironment : LPSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetEnvironmentStringsA(
    NewEnvironment: [*c]const u8 // LPSTR
) callconv(std.os.windows.WINAPI) i32;
proc SetEnvironmentStringsA(
    NewEnvironment: cstring  # LPSTR
): int32 {.importc: "SetEnvironmentStringsA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetEnvironmentStringsA(
    const(char)* NewEnvironment   // LPSTR
);
ccall((:SetEnvironmentStringsA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring,),
      NewEnvironment)
# NewEnvironment : LPSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetEnvironmentStringsA(
    const char* NewEnvironment);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetEnvironmentStringsA(NewEnvironment)
-- NewEnvironment : LPSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetEnvironmentStringsA = lib.func('__stdcall', 'SetEnvironmentStringsA', 'int32_t', ['str']);
// SetEnvironmentStringsA(NewEnvironment)
// NewEnvironment : LPSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetEnvironmentStringsA: { parameters: ["buffer"], result: "i32" },
});
// lib.symbols.SetEnvironmentStringsA(NewEnvironment)
// NewEnvironment : LPSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetEnvironmentStringsA(
    const char* NewEnvironment);
C, "KERNEL32.dll");
// $ffi->SetEnvironmentStringsA(NewEnvironment);
// NewEnvironment : LPSTR
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean SetEnvironmentStringsA(
        String NewEnvironment   // LPSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetEnvironmentStringsA = SetEnvironmentStringsA(
    NewEnvironment : UInt8*   # LPSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetEnvironmentStringsANative = Int32 Function(Pointer<Utf8>);
typedef SetEnvironmentStringsADart = int Function(Pointer<Utf8>);
final SetEnvironmentStringsA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetEnvironmentStringsANative, SetEnvironmentStringsADart>('SetEnvironmentStringsA');
// NewEnvironment : LPSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetEnvironmentStringsA(
  NewEnvironment: PAnsiChar   // LPSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetEnvironmentStringsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetEnvironmentStringsA"
  c_SetEnvironmentStringsA :: CString -> IO CInt
-- NewEnvironment : LPSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setenvironmentstringsa =
  foreign "SetEnvironmentStringsA"
    (string @-> returning int32_t)
(* NewEnvironment : LPSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetEnvironmentStringsA" set-environment-strings-a :convention :stdcall) :int32
  (new-environment :string))   ; LPSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetEnvironmentStringsA = Win32::API::More->new('KERNEL32',
    'BOOL SetEnvironmentStringsA(LPCSTR NewEnvironment)');
# my $ret = $SetEnvironmentStringsA->Call($NewEnvironment);
# NewEnvironment : LPSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い