ホーム › System.WindowsProgramming › WritePrivateProfileSectionA

WritePrivateProfileSectionA

関数

指定iniファイルのセクション全体をANSIで書き込む。

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

シグネチャ

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

BOOL WritePrivateProfileSectionA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpString,   // optional
    LPCSTR lpFileName   // optional
);

パラメーター

名前	型	方向	説明
lpAppName	LPCSTR	inoptional	データの書き込み先となるセクションの名前。このセクション名は通常、呼び出し元アプリケーションの名前です。
lpString	LPCSTR	inoptional	指定されたセクションに書き込む新しいキー名と、それに関連付けられる値。この文字列は 65,535 バイトに制限されます。
lpFileName	LPCSTR	inoptional	初期化ファイルの名前。このパラメーターにファイルの完全なパスが含まれていない場合、関数は Windows ディレクトリ内でそのファイルを検索します。ファイルが存在せず、lpFileName に完全なパスが含まれていない場合、関数は Windows ディレクトリにファイルを作成します。ファイルが存在し、Unicode 文字を使用して作成されていた場合、関数は Unicode 文字をファイルに書き込みます。それ以外の場合、関数は ANSI 文字を使用してファイルを作成します。

名前

型

方向

説明

lpAppName

LPCSTR

inoptional

データの書き込み先となるセクションの名前。このセクション名は通常、呼び出し元アプリケーションの名前です。

lpString

LPCSTR

inoptional

指定されたセクションに書き込む新しいキー名と、それに関連付けられる値。この文字列は 65,535 バイトに制限されます。

lpFileName

LPCSTR

inoptional

初期化ファイルの名前。このパラメーターにファイルの完全なパスが含まれていない場合、関数は Windows ディレクトリ内でそのファイルを検索します。ファイルが存在せず、lpFileName に完全なパスが含まれていない場合、関数は Windows ディレクトリにファイルを作成します。

ファイルが存在し、Unicode 文字を使用して作成されていた場合、関数は Unicode 文字をファイルに書き込みます。それ以外の場合、関数は ANSI 文字を使用してファイルを作成します。

戻り値の型: BOOL

公式ドキュメント

初期化ファイル内の指定されたセクションのキーと値を置き換えます。(ANSI)

戻り値

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

lpString パラメーターが指すバッファー内のデータは、1 つ以上の null 終端文字列と、それに続く最後の null 文字で構成されます。各文字列は次の形式を持ちます。

key=string

WritePrivateProfileSection 関数は大文字と小文字を区別しません。lpAppName パラメーターが指す文字列には、大文字と小文字を組み合わせて指定できます。

lpAppName パラメーターが指す文字列に一致するセクション名が存在しない場合、 WritePrivateProfileSection は指定された初期化ファイルの末尾にセクションを作成し、指定されたキー名と値のペアで新しいセクションを初期化します。

WritePrivateProfileSection は、指定されたセクションの既存のキーと値を削除し、lpString パラメーターが指すバッファー内のキー名と値を挿入します。この関数は、古いキー名と新しいキー名を対応付けようとはしません。新しい名前が古い名前と異なる順序で並んでいる場合、初期化ファイル内の既存のキーおよび値に関連付けられていたコメントは、誤ったキーおよび値に関連付けられる可能性があります。

この操作はアトミックです。情報の書き込み中は、指定された初期化ファイルに対する読み取りまたは書き込みの操作は一切許可されません。

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

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

HKEY_LOCAL_MACHINE
   SOFTWARE
      Microsoft
         Windows NT
            CurrentVersion
               IniFileMapping

このマッピングは、アプリケーションが Control.ini、System.ini、Winfile.ini などのシステムコンポーネントの初期化ファイルを変更する場合に適用される可能性が高くなります。この場合、関数は初期化ファイルではなくレジストリに情報を書き込みます。格納場所が変わっても、関数の動作には影響しません。

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

レジストリの 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 版を自動的に選択するエイリアスとして WritePrivateProfileSection を定義しています。エンコードに依存しないエイリアスの使用と、エンコードに依存しないわけではないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 WritePrivateProfileSectionA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpString,   // optional
    LPCSTR lpFileName   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WritePrivateProfileSectionA(
    [MarshalAs(UnmanagedType.LPStr)] string lpAppName,   // 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 WritePrivateProfileSectionA(
    <MarshalAs(UnmanagedType.LPStr)> lpAppName 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
' lpString : LPCSTR optional
' lpFileName : LPCSTR optional
Declare PtrSafe Function WritePrivateProfileSectionA Lib "kernel32" ( _
    ByVal lpAppName 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

WritePrivateProfileSectionA = ctypes.windll.kernel32.WritePrivateProfileSectionA
WritePrivateProfileSectionA.restype = wintypes.BOOL
WritePrivateProfileSectionA.argtypes = [
    wintypes.LPCSTR,  # lpAppName : 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')
WritePrivateProfileSectionA = Fiddle::Function.new(
  lib['WritePrivateProfileSectionA'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpString : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn WritePrivateProfileSectionA(
        lpAppName: *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 WritePrivateProfileSectionA([MarshalAs(UnmanagedType.LPStr)] string lpAppName, [MarshalAs(UnmanagedType.LPStr)] string lpString, [MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WritePrivateProfileSectionA' -Namespace Win32 -PassThru
# $api::WritePrivateProfileSectionA(lpAppName, lpString, lpFileName)

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWritePrivateProfileSectionA = kernel32.NewProc("WritePrivateProfileSectionA")
)

// lpAppName (LPCSTR optional), lpString (LPCSTR optional), lpFileName (LPCSTR optional)
r1, _, err := procWritePrivateProfileSectionA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpAppName))),
	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 WritePrivateProfileSectionA(
  lpAppName: PAnsiChar;   // LPCSTR optional
  lpString: PAnsiChar;   // LPCSTR optional
  lpFileName: PAnsiChar   // LPCSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WritePrivateProfileSectionA';

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

●WritePrivateProfileSectionA(lpAppName, lpString, lpFileName) = DLL("KERNEL32.dll", "bool WritePrivateProfileSectionA(char*, char*, char*)")
# 呼び出し: WritePrivateProfileSectionA(lpAppName, lpString, lpFileName)
# lpAppName : 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 WritePrivateProfileSectionA(
    lpAppName: [*c]const u8, // LPCSTR optional
    lpString: [*c]const u8, // LPCSTR optional
    lpFileName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;

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

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

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

local ffi = require("ffi")
ffi.cdef[[
int32_t WritePrivateProfileSectionA(
    const char* lpAppName,
    const char* lpString,
    const char* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WritePrivateProfileSectionA(lpAppName, lpString, lpFileName)
-- lpAppName : 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 WritePrivateProfileSectionA = lib.func('__stdcall', 'WritePrivateProfileSectionA', 'int32_t', ['str', 'str', 'str']);
// WritePrivateProfileSectionA(lpAppName, lpString, lpFileName)
// lpAppName : LPCSTR optional -> 'str'
// lpString : LPCSTR optional -> 'str'
// lpFileName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("KERNEL32.dll", {
  WritePrivateProfileSectionA: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WritePrivateProfileSectionA(lpAppName, lpString, lpFileName)
// lpAppName : 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 WritePrivateProfileSectionA(
    const char* lpAppName,
    const char* lpString,
    const char* lpFileName);
C, "KERNEL32.dll");
// $ffi->WritePrivateProfileSectionA(lpAppName, lpString, lpFileName);
// lpAppName : 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 WritePrivateProfileSectionA(
        String lpAppName,   // LPCSTR optional
        String lpString,   // LPCSTR optional
        String lpFileName   // LPCSTR optional
    );
}

@[Link("kernel32")]
lib LibKERNEL32
  fun WritePrivateProfileSectionA = WritePrivateProfileSectionA(
    lpAppName : 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 WritePrivateProfileSectionANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef WritePrivateProfileSectionADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final WritePrivateProfileSectionA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WritePrivateProfileSectionANative, WritePrivateProfileSectionADart>('WritePrivateProfileSectionA');
// lpAppName : LPCSTR optional -> Pointer<Utf8>
// lpString : LPCSTR optional -> Pointer<Utf8>
// lpFileName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

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

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

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

open Ctypes
open Foreign

let writeprivateprofilesectiona =
  foreign "WritePrivateProfileSectionA"
    (string @-> string @-> string @-> returning int32_t)
(* lpAppName : 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 ("WritePrivateProfileSectionA" write-private-profile-section-a :convention :stdcall) :int32
  (lp-app-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 $WritePrivateProfileSectionA = Win32::API::More->new('KERNEL32',
    'BOOL WritePrivateProfileSectionA(LPCSTR lpAppName, LPCSTR lpString, LPCSTR lpFileName)');
# my $ret = $WritePrivateProfileSectionA->Call($lpAppName, $lpString, $lpFileName);
# lpAppName : LPCSTR optional -> LPCSTR
# lpString : LPCSTR optional -> LPCSTR
# lpFileName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

WritePrivateProfileSectionA

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目