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

WriteProfileStringW

関数
win.iniへ文字列をUnicodeで書き込む旧式関数。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL WriteProfileStringW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpKeyName,   // optional
    LPCWSTR lpString   // optional
);

パラメーター

名前方向説明
lpAppNameLPCWSTRinoptionalwin.ini内のセクション名(ワイド)。
lpKeyNameLPCWSTRinoptional書き込むキー名(ワイド)。NULLでセクションごと削除。
lpStringLPCWSTRinoptional書き込む文字列値(ワイド)。NULLでキーを削除。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL WriteProfileStringW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpKeyName,   // optional
    LPCWSTR lpString   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WriteProfileStringW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpAppName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteProfileStringW(
    <MarshalAs(UnmanagedType.LPWStr)> lpAppName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpKeyName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' lpAppName : LPCWSTR optional
' lpKeyName : LPCWSTR optional
' lpString : LPCWSTR optional
Declare PtrSafe Function WriteProfileStringW Lib "kernel32" ( _
    ByVal lpAppName As LongPtr, _
    ByVal lpKeyName As LongPtr, _
    ByVal lpString As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WriteProfileStringW = ctypes.windll.kernel32.WriteProfileStringW
WriteProfileStringW.restype = wintypes.BOOL
WriteProfileStringW.argtypes = [
    wintypes.LPCWSTR,  # lpAppName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpKeyName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpString : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WriteProfileStringW = Fiddle::Function.new(
  lib['WriteProfileStringW'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpKeyName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn WriteProfileStringW(
        lpAppName: *const u16,  // LPCWSTR optional
        lpKeyName: *const u16,  // LPCWSTR optional
        lpString: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool WriteProfileStringW([MarshalAs(UnmanagedType.LPWStr)] string lpAppName, [MarshalAs(UnmanagedType.LPWStr)] string lpKeyName, [MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteProfileStringW' -Namespace Win32 -PassThru
# $api::WriteProfileStringW(lpAppName, lpKeyName, lpString)
#uselib "KERNEL32.dll"
#func global WriteProfileStringW "WriteProfileStringW" wptr, wptr, wptr
; WriteProfileStringW lpAppName, lpKeyName, lpString   ; 戻り値は stat
; lpAppName : LPCWSTR optional -> "wptr"
; lpKeyName : LPCWSTR optional -> "wptr"
; lpString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global WriteProfileStringW "WriteProfileStringW" wstr, wstr, wstr
; res = WriteProfileStringW(lpAppName, lpKeyName, lpString)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpString : LPCWSTR optional -> "wstr"
; BOOL WriteProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global WriteProfileStringW "WriteProfileStringW" wstr, wstr, wstr
; res = WriteProfileStringW(lpAppName, lpKeyName, lpString)
; lpAppName : LPCWSTR optional -> "wstr"
; lpKeyName : LPCWSTR optional -> "wstr"
; lpString : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteProfileStringW = kernel32.NewProc("WriteProfileStringW")
)

// lpAppName (LPCWSTR optional), lpKeyName (LPCWSTR optional), lpString (LPCWSTR optional)
r1, _, err := procWriteProfileStringW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpAppName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpKeyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WriteProfileStringW(
  lpAppName: PWideChar;   // LPCWSTR optional
  lpKeyName: PWideChar;   // LPCWSTR optional
  lpString: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteProfileStringW';
result := DllCall("KERNEL32\WriteProfileStringW"
    , "WStr", lpAppName   ; LPCWSTR optional
    , "WStr", lpKeyName   ; LPCWSTR optional
    , "WStr", lpString   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●WriteProfileStringW(lpAppName, lpKeyName, lpString) = DLL("KERNEL32.dll", "bool WriteProfileStringW(char*, char*, char*)")
# 呼び出し: WriteProfileStringW(lpAppName, lpKeyName, lpString)
# lpAppName : LPCWSTR optional -> "char*"
# lpKeyName : LPCWSTR optional -> "char*"
# lpString : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn WriteProfileStringW(
    lpAppName: [*c]const u16, // LPCWSTR optional
    lpKeyName: [*c]const u16, // LPCWSTR optional
    lpString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WriteProfileStringW(
    lpAppName: WideCString,  # LPCWSTR optional
    lpKeyName: WideCString,  # LPCWSTR optional
    lpString: WideCString  # LPCWSTR optional
): int32 {.importc: "WriteProfileStringW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int WriteProfileStringW(
    const(wchar)* lpAppName,   // LPCWSTR optional
    const(wchar)* lpKeyName,   // LPCWSTR optional
    const(wchar)* lpString   // LPCWSTR optional
);
ccall((:WriteProfileStringW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring),
      lpAppName, lpKeyName, lpString)
# lpAppName : LPCWSTR optional -> Cwstring
# lpKeyName : LPCWSTR optional -> Cwstring
# lpString : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WriteProfileStringW(
    const uint16_t* lpAppName,
    const uint16_t* lpKeyName,
    const uint16_t* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteProfileStringW(lpAppName, lpKeyName, lpString)
-- lpAppName : LPCWSTR optional
-- lpKeyName : LPCWSTR optional
-- lpString : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteProfileStringW = lib.func('__stdcall', 'WriteProfileStringW', 'int32_t', ['str16', 'str16', 'str16']);
// WriteProfileStringW(lpAppName, lpKeyName, lpString)
// lpAppName : LPCWSTR optional -> 'str16'
// lpKeyName : LPCWSTR optional -> 'str16'
// lpString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WriteProfileStringW: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WriteProfileStringW(lpAppName, lpKeyName, lpString)
// lpAppName : LPCWSTR optional -> "buffer"
// lpKeyName : LPCWSTR optional -> "buffer"
// lpString : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WriteProfileStringW(
    const uint16_t* lpAppName,
    const uint16_t* lpKeyName,
    const uint16_t* lpString);
C, "KERNEL32.dll");
// $ffi->WriteProfileStringW(lpAppName, lpKeyName, lpString);
// lpAppName : LPCWSTR optional
// lpKeyName : LPCWSTR optional
// lpString : LPCWSTR optional
// 構造体/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.UNICODE_OPTIONS);
    boolean WriteProfileStringW(
        WString lpAppName,   // LPCWSTR optional
        WString lpKeyName,   // LPCWSTR optional
        WString lpString   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun WriteProfileStringW = WriteProfileStringW(
    lpAppName : UInt16*,   # LPCWSTR optional
    lpKeyName : UInt16*,   # LPCWSTR optional
    lpString : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WriteProfileStringWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
typedef WriteProfileStringWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
final WriteProfileStringW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteProfileStringWNative, WriteProfileStringWDart>('WriteProfileStringW');
// lpAppName : LPCWSTR optional -> Pointer<Utf16>
// lpKeyName : LPCWSTR optional -> Pointer<Utf16>
// lpString : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteProfileStringW(
  lpAppName: PWideChar;   // LPCWSTR optional
  lpKeyName: PWideChar;   // LPCWSTR optional
  lpString: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteProfileStringW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteProfileStringW"
  c_WriteProfileStringW :: CWString -> CWString -> CWString -> IO CInt
-- lpAppName : LPCWSTR optional -> CWString
-- lpKeyName : LPCWSTR optional -> CWString
-- lpString : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let writeprofilestringw =
  foreign "WriteProfileStringW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpAppName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpKeyName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpString : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("WriteProfileStringW" write-profile-string-w :convention :stdcall) :int32
  (lp-app-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-key-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-string (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteProfileStringW = Win32::API::More->new('KERNEL32',
    'BOOL WriteProfileStringW(LPCWSTR lpAppName, LPCWSTR lpKeyName, LPCWSTR lpString)');
# my $ret = $WriteProfileStringW->Call($lpAppName, $lpKeyName, $lpString);
# lpAppName : LPCWSTR optional -> LPCWSTR
# lpKeyName : LPCWSTR optional -> LPCWSTR
# lpString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い