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

WritePrivateProfileStringA

関数
指定iniファイルへ文字列をANSIで書き込む。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL WritePrivateProfileStringA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpKeyName,   // optional
    LPCSTR lpString,   // optional
    LPCSTR lpFileName   // optional
);

パラメーター

名前方向説明
lpAppNameLPCSTRinoptionaliniファイル内のセクション名(ANSI)。
lpKeyNameLPCSTRinoptional書き込むキー名(ANSI)。NULLでセクションごと削除。
lpStringLPCSTRinoptional書き込む文字列値(ANSI)。NULLでキーを削除。
lpFileNameLPCSTRinoptional対象のiniファイルのパス(ANSI)。存在しなければ作成される。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('KERNEL32.dll')
WritePrivateProfileStringA = Fiddle::Function.new(
  lib['WritePrivateProfileStringA'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpKeyName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WritePrivateProfileStringA(
        lpAppName: *const u8,  // LPCSTR optional
        lpKeyName: *const u8,  // LPCSTR optional
        lpString: *const u8,  // LPCSTR optional
        lpFileName: *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 WritePrivateProfileStringA([MarshalAs(UnmanagedType.LPStr)] string lpAppName, [MarshalAs(UnmanagedType.LPStr)] string lpKeyName, [MarshalAs(UnmanagedType.LPStr)] string lpString, [MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WritePrivateProfileStringA' -Namespace Win32 -PassThru
# $api::WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
#uselib "KERNEL32.dll"
#func global WritePrivateProfileStringA "WritePrivateProfileStringA" sptr, sptr, sptr, sptr
; WritePrivateProfileStringA lpAppName, lpKeyName, lpString, lpFileName   ; 戻り値は stat
; lpAppName : LPCSTR optional -> "sptr"
; lpKeyName : LPCSTR optional -> "sptr"
; lpString : LPCSTR optional -> "sptr"
; lpFileName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global WritePrivateProfileStringA "WritePrivateProfileStringA" str, str, str, str
; res = WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
; lpAppName : LPCSTR optional -> "str"
; lpKeyName : LPCSTR optional -> "str"
; lpString : LPCSTR optional -> "str"
; lpFileName : LPCSTR optional -> "str"
; BOOL WritePrivateProfileStringA(LPCSTR lpAppName, LPCSTR lpKeyName, LPCSTR lpString, LPCSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global WritePrivateProfileStringA "WritePrivateProfileStringA" str, str, str, str
; res = WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
; lpAppName : LPCSTR optional -> "str"
; lpKeyName : LPCSTR optional -> "str"
; lpString : LPCSTR optional -> "str"
; lpFileName : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWritePrivateProfileStringA = kernel32.NewProc("WritePrivateProfileStringA")
)

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

extern "kernel32" fn WritePrivateProfileStringA(
    lpAppName: [*c]const u8, // LPCSTR optional
    lpKeyName: [*c]const u8, // LPCSTR optional
    lpString: [*c]const u8, // LPCSTR optional
    lpFileName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;
proc WritePrivateProfileStringA(
    lpAppName: cstring,  # LPCSTR optional
    lpKeyName: cstring,  # LPCSTR optional
    lpString: cstring,  # LPCSTR optional
    lpFileName: cstring  # LPCSTR optional
): int32 {.importc: "WritePrivateProfileStringA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int WritePrivateProfileStringA(
    const(char)* lpAppName,   // LPCSTR optional
    const(char)* lpKeyName,   // LPCSTR optional
    const(char)* lpString,   // LPCSTR optional
    const(char)* lpFileName   // LPCSTR optional
);
ccall((:WritePrivateProfileStringA, "KERNEL32.dll"), stdcall, Int32,
      (Cstring, Cstring, Cstring, Cstring),
      lpAppName, lpKeyName, lpString, lpFileName)
# lpAppName : LPCSTR optional -> Cstring
# lpKeyName : LPCSTR optional -> Cstring
# lpString : LPCSTR optional -> Cstring
# lpFileName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WritePrivateProfileStringA(
    const char* lpAppName,
    const char* lpKeyName,
    const char* lpString,
    const char* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
-- lpAppName : LPCSTR optional
-- lpKeyName : LPCSTR optional
-- lpString : LPCSTR optional
-- lpFileName : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WritePrivateProfileStringA = lib.func('__stdcall', 'WritePrivateProfileStringA', 'int32_t', ['str', 'str', 'str', 'str']);
// WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
// lpAppName : LPCSTR optional -> 'str'
// lpKeyName : LPCSTR optional -> 'str'
// lpString : LPCSTR optional -> 'str'
// lpFileName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WritePrivateProfileStringA: { parameters: ["buffer", "buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName)
// lpAppName : LPCSTR optional -> "buffer"
// lpKeyName : LPCSTR optional -> "buffer"
// lpString : LPCSTR optional -> "buffer"
// lpFileName : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WritePrivateProfileStringA(
    const char* lpAppName,
    const char* lpKeyName,
    const char* lpString,
    const char* lpFileName);
C, "KERNEL32.dll");
// $ffi->WritePrivateProfileStringA(lpAppName, lpKeyName, lpString, lpFileName);
// lpAppName : LPCSTR optional
// lpKeyName : LPCSTR optional
// lpString : LPCSTR optional
// lpFileName : 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 WritePrivateProfileStringA(
        String lpAppName,   // LPCSTR optional
        String lpKeyName,   // LPCSTR optional
        String lpString,   // LPCSTR optional
        String lpFileName   // LPCSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WritePrivateProfileStringA = WritePrivateProfileStringA(
    lpAppName : UInt8*,   # LPCSTR optional
    lpKeyName : UInt8*,   # LPCSTR optional
    lpString : UInt8*,   # LPCSTR optional
    lpFileName : 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 WritePrivateProfileStringANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef WritePrivateProfileStringADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final WritePrivateProfileStringA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WritePrivateProfileStringANative, WritePrivateProfileStringADart>('WritePrivateProfileStringA');
// lpAppName : LPCSTR optional -> Pointer<Utf8>
// lpKeyName : LPCSTR optional -> Pointer<Utf8>
// lpString : LPCSTR optional -> Pointer<Utf8>
// lpFileName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WritePrivateProfileStringA(
  lpAppName: PAnsiChar;   // LPCSTR optional
  lpKeyName: PAnsiChar;   // LPCSTR optional
  lpString: PAnsiChar;   // LPCSTR optional
  lpFileName: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WritePrivateProfileStringA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let writeprivateprofilestringa =
  foreign "WritePrivateProfileStringA"
    (string @-> string @-> string @-> string @-> returning int32_t)
(* lpAppName : LPCSTR optional -> string *)
(* lpKeyName : LPCSTR optional -> string *)
(* lpString : LPCSTR optional -> string *)
(* lpFileName : 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 ("WritePrivateProfileStringA" write-private-profile-string-a :convention :stdcall) :int32
  (lp-app-name :string)   ; LPCSTR optional
  (lp-key-name :string)   ; LPCSTR optional
  (lp-string :string)   ; LPCSTR optional
  (lp-file-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WritePrivateProfileStringA = Win32::API::More->new('KERNEL32',
    'BOOL WritePrivateProfileStringA(LPCSTR lpAppName, LPCSTR lpKeyName, LPCSTR lpString, LPCSTR lpFileName)');
# my $ret = $WritePrivateProfileStringA->Call($lpAppName, $lpKeyName, $lpString, $lpFileName);
# lpAppName : LPCSTR optional -> LPCSTR
# lpKeyName : LPCSTR optional -> LPCSTR
# lpString : LPCSTR optional -> LPCSTR
# lpFileName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い