ホーム › System.WindowsProgramming › WriteProfileStringA

WriteProfileStringA

関数

win.iniへ文字列をANSIで書き込む旧式関数。

DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL WriteProfileStringA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpKeyName,   // optional
    LPCSTR lpString   // optional
);

パラメーター

名前	型	方向	説明
lpAppName	LPCSTR	inoptional	文字列のコピー先となるセクション。セクションが存在しない場合は作成されます。セクション名は大文字と小文字を区別しません。文字列には大文字と小文字の任意の組み合わせを指定できます。
lpKeyName	LPCSTR	inoptional	文字列に関連付けるキー。指定したセクションにキーが存在しない場合は作成されます。このパラメーターが NULL の場合、セクション内のすべてのエントリを含め、セクション全体が削除されます。
lpString	LPCSTR	inoptional	ファイルに書き込む null 終端文字列。このパラメーターが NULL の場合、lpKeyName パラメーターが指すキーが削除されます。

戻り値の型: BOOL

公式ドキュメント

Win.ini ファイルの指定されたセクションに文字列をコピーします。(ANSI)

戻り値

関数が Win.ini ファイルへの文字列のコピーに成功した場合、戻り値は 0 以外です。

関数が失敗した場合、または Win.ini のキャッシュされたバージョンをフラッシュした場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

Win.ini ファイル内のセクションは、次の形式である必要があります: key=string。

システムは、パフォーマンスを向上させるために、最新のレジストリファイルマッピングのキャッシュされたバージョンを保持します。すべてのパラメーターが NULL の場合、この関数はキャッシュをフラッシュします。システムがファイルのキャッシュされたバージョンを編集している間、ファイル自体を編集するプロセスは、キャッシュがクリアされるまで元のファイルを使用します。

システムは、次のレジストリキーの下で定義されたマッピングを使用して、ほとんどの .ini ファイルへの参照をレジストリにマップします:

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows NT
            CurrentVersion
               IniFileMapping

操作がマップされている場合、 WriteProfileString 関数は初期化ファイルではなくレジストリに情報を書き込みます。格納場所が変わっても、この関数の動作には影響しません。

プロファイル関数は、次の手順で初期化情報を検索します。

IniFileMapping キーの下で、レジストリ内の初期化ファイルの名前を探します。
lpAppName で指定されたセクション名を探します。これは初期化ファイルの名前を持つキーの下の名前付きの値、またはその名前を持つサブキーであるか、あるいは値としてもサブキーとしても存在しません。
lpAppName で指定されたセクション名が名前付きの値である場合、その値は、そのセクションのキーがレジストリ内のどこにあるかを示します。
lpAppName で指定されたセクション名がサブキーである場合、そのサブキーの下の名前付きの値が、そのセクションのキーがレジストリ内のどこにあるかを示します。探しているキーが名前付きの値として存在しない場合は、そのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) が存在します。
lpAppName で指定されたセクション名が名前付きの値としてもサブキーとしても存在しない場合は、そのセクションのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) が存在します。
そのセクション名に対応するサブキーやエントリが存在しない場合は、ディスク上の実際の初期化ファイルを探して、その内容を読み取ります。

他のレジストリの場所を指定するレジストリ内の値を参照する際には、.ini ファイルのマッピングの動作を変更するいくつかのプレフィックスがあります。

! - この文字は、すべての書き込みをレジストリとディスク上の .ini ファイルの両方に対して強制的に行います。
# - この文字は、セットアップ後に新しいユーザーが初めてログオンしたときに、レジストリの値を Windows 3.1 の .ini ファイル内の値に設定します。
@ - この文字は、要求されたデータがレジストリ内に見つからない場合でも、ディスク上の .ini ファイルからの読み取りを行わないようにします。
USR: - このプレフィックスは HKEY_CURRENT_USER を表し、プレフィックスに続くテキストはそのキーからの相対パスです。
SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWARE を表し、プレフィックスに続くテキストはそのキーからの相対パスです。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして WriteProfileString を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

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

BOOL WriteProfileStringA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpKeyName,   // optional
    LPCSTR lpString   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WriteProfileStringA(
    [MarshalAs(UnmanagedType.LPStr)] string lpAppName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpKeyName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpString   // LPCSTR optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteProfileStringA(
    <MarshalAs(UnmanagedType.LPStr)> lpAppName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpKeyName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpString As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpAppName : LPCSTR optional
' lpKeyName : LPCSTR optional
' lpString : LPCSTR optional
Declare PtrSafe Function WriteProfileStringA Lib "kernel32" ( _
    ByVal lpAppName As String, _
    ByVal lpKeyName As String, _
    ByVal lpString As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WriteProfileStringA = ctypes.windll.kernel32.WriteProfileStringA
WriteProfileStringA.restype = wintypes.BOOL
WriteProfileStringA.argtypes = [
    wintypes.LPCSTR,  # lpAppName : LPCSTR optional
    wintypes.LPCSTR,  # lpKeyName : LPCSTR optional
    wintypes.LPCSTR,  # lpString : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WriteProfileStringA = Fiddle::Function.new(
  lib['WriteProfileStringA'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpKeyName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn WriteProfileStringA(
        lpAppName: *const u8,  // LPCSTR optional
        lpKeyName: *const u8,  // LPCSTR optional
        lpString: *const u8  // LPCSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool WriteProfileStringA([MarshalAs(UnmanagedType.LPStr)] string lpAppName, [MarshalAs(UnmanagedType.LPStr)] string lpKeyName, [MarshalAs(UnmanagedType.LPStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WriteProfileStringA' -Namespace Win32 -PassThru
# $api::WriteProfileStringA(lpAppName, lpKeyName, lpString)

#uselib "KERNEL32.dll"
#func global WriteProfileStringA "WriteProfileStringA" sptr, sptr, sptr
; WriteProfileStringA lpAppName, lpKeyName, lpString   ; 戻り値は stat
; lpAppName : LPCSTR optional -> "sptr"
; lpKeyName : LPCSTR optional -> "sptr"
; lpString : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "KERNEL32.dll"
#cfunc global WriteProfileStringA "WriteProfileStringA" str, str, str
; res = WriteProfileStringA(lpAppName, lpKeyName, lpString)
; lpAppName : LPCSTR optional -> "str"
; lpKeyName : LPCSTR optional -> "str"
; lpString : LPCSTR optional -> "str"

; BOOL WriteProfileStringA(LPCSTR lpAppName, LPCSTR lpKeyName, LPCSTR lpString)
#uselib "KERNEL32.dll"
#cfunc global WriteProfileStringA "WriteProfileStringA" str, str, str
; res = WriteProfileStringA(lpAppName, lpKeyName, lpString)
; lpAppName : LPCSTR optional -> "str"
; lpKeyName : LPCSTR optional -> "str"
; lpString : LPCSTR optional -> "str"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteProfileStringA = kernel32.NewProc("WriteProfileStringA")
)

// lpAppName (LPCSTR optional), lpKeyName (LPCSTR optional), lpString (LPCSTR optional)
r1, _, err := procWriteProfileStringA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpAppName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpKeyName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WriteProfileStringA(
  lpAppName: PAnsiChar;   // LPCSTR optional
  lpKeyName: PAnsiChar;   // LPCSTR optional
  lpString: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteProfileStringA';

result := DllCall("KERNEL32\WriteProfileStringA"
    , "AStr", lpAppName   ; LPCSTR optional
    , "AStr", lpKeyName   ; LPCSTR optional
    , "AStr", lpString   ; LPCSTR optional
    , "Int")   ; return: BOOL

●WriteProfileStringA(lpAppName, lpKeyName, lpString) = DLL("KERNEL32.dll", "bool WriteProfileStringA(char*, char*, char*)")
# 呼び出し: WriteProfileStringA(lpAppName, lpKeyName, lpString)
# lpAppName : LPCSTR optional -> "char*"
# lpKeyName : LPCSTR optional -> "char*"
# lpString : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "kernel32" fn WriteProfileStringA(
    lpAppName: [*c]const u8, // LPCSTR optional
    lpKeyName: [*c]const u8, // LPCSTR optional
    lpString: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;

proc WriteProfileStringA(
    lpAppName: cstring,  # LPCSTR optional
    lpKeyName: cstring,  # LPCSTR optional
    lpString: cstring  # LPCSTR optional
): int32 {.importc: "WriteProfileStringA", stdcall, dynlib: "KERNEL32.dll".}

pragma(lib, "kernel32");
extern(Windows)
int WriteProfileStringA(
    const(char)* lpAppName,   // LPCSTR optional
    const(char)* lpKeyName,   // LPCSTR optional
    const(char)* lpString   // LPCSTR optional
);

ccall((:WriteProfileStringA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Cstring),
      lpAppName, lpKeyName, lpString)
# lpAppName : LPCSTR optional -> Cstring
# lpKeyName : LPCSTR optional -> Cstring
# lpString : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t WriteProfileStringA(
    const char* lpAppName,
    const char* lpKeyName,
    const char* lpString);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteProfileStringA(lpAppName, lpKeyName, lpString)
-- lpAppName : LPCSTR optional
-- lpKeyName : LPCSTR optional
-- lpString : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteProfileStringA = lib.func('__stdcall', 'WriteProfileStringA', 'int32_t', ['str', 'str', 'str']);
// WriteProfileStringA(lpAppName, lpKeyName, lpString)
// lpAppName : LPCSTR optional -> 'str'
// lpKeyName : LPCSTR optional -> 'str'
// lpString : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  WriteProfileStringA: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WriteProfileStringA(lpAppName, lpKeyName, lpString)
// lpAppName : LPCSTR optional -> "buffer"
// lpKeyName : LPCSTR optional -> "buffer"
// lpString : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WriteProfileStringA(
    const char* lpAppName,
    const char* lpKeyName,
    const char* lpString);
C, "KERNEL32.dll");
// $ffi->WriteProfileStringA(lpAppName, lpKeyName, lpString);
// lpAppName : LPCSTR optional
// lpKeyName : LPCSTR optional
// lpString : LPCSTR 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.ASCII_OPTIONS);
    boolean WriteProfileStringA(
        String lpAppName,   // LPCSTR optional
        String lpKeyName,   // LPCSTR optional
        String lpString   // LPCSTR optional
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun WriteProfileStringA = WriteProfileStringA(
    lpAppName : UInt8*,   # LPCSTR optional
    lpKeyName : UInt8*,   # LPCSTR optional
    lpString : UInt8*   # LPCSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WriteProfileStringANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef WriteProfileStringADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final WriteProfileStringA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteProfileStringANative, WriteProfileStringADart>('WriteProfileStringA');
// lpAppName : LPCSTR optional -> Pointer<Utf8>
// lpKeyName : LPCSTR optional -> Pointer<Utf8>
// lpString : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function WriteProfileStringA(
  lpAppName: PAnsiChar;   // LPCSTR optional
  lpKeyName: PAnsiChar;   // LPCSTR optional
  lpString: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteProfileStringA';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WriteProfileStringA"
  c_WriteProfileStringA :: CString -> CString -> CString -> IO CInt
-- lpAppName : LPCSTR optional -> CString
-- lpKeyName : LPCSTR optional -> CString
-- lpString : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let writeprofilestringa =
  foreign "WriteProfileStringA"
    (string @-> string @-> string @-> returning int32_t)
(* lpAppName : LPCSTR optional -> string *)
(* lpKeyName : LPCSTR optional -> string *)
(* lpString : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("WriteProfileStringA" write-profile-string-a :convention :stdcall) :int32
  (lp-app-name :string)   ; LPCSTR optional
  (lp-key-name :string)   ; LPCSTR optional
  (lp-string :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $WriteProfileStringA = Win32::API::More->new('KERNEL32',
    'BOOL WriteProfileStringA(LPCSTR lpAppName, LPCSTR lpKeyName, LPCSTR lpString)');
# my $ret = $WriteProfileStringA->Call($lpAppName, $lpKeyName, $lpString);
# lpAppName : LPCSTR optional -> LPCSTR
# lpKeyName : LPCSTR optional -> LPCSTR
# lpString : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。