ホーム › System.WindowsProgramming › WritePrivateProfileSectionW

WritePrivateProfileSectionW

関数

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

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

シグネチャ

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

BOOL WritePrivateProfileSectionW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpString,   // optional
    LPCWSTR lpFileName   // optional
);

パラメーター

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

名前

型

方向

説明

lpAppName

LPCWSTR

inoptional

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

lpString

LPCWSTR

inoptional

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

lpFileName

LPCWSTR

inoptional

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (Unicode / -W)
#include <windows.h>

BOOL WritePrivateProfileSectionW(
    LPCWSTR lpAppName,   // optional
    LPCWSTR lpString,   // optional
    LPCWSTR lpFileName   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WritePrivateProfileSectionW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpAppName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpString,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName   // LPCWSTR optional
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WritePrivateProfileSectionW(
    <MarshalAs(UnmanagedType.LPWStr)> lpAppName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpAppName : LPCWSTR optional
' lpString : LPCWSTR optional
' lpFileName : LPCWSTR optional
Declare PtrSafe Function WritePrivateProfileSectionW Lib "kernel32" ( _
    ByVal lpAppName As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal lpFileName 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WritePrivateProfileSectionW = Fiddle::Function.new(
  lib['WritePrivateProfileSectionW'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

#uselib "KERNEL32.dll"
#cfunc global WritePrivateProfileSectionW "WritePrivateProfileSectionW" wstr, wstr, wstr
; res = WritePrivateProfileSectionW(lpAppName, lpString, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpString : LPCWSTR optional -> "wstr"
; lpFileName : LPCWSTR optional -> "wstr"

; BOOL WritePrivateProfileSectionW(LPCWSTR lpAppName, LPCWSTR lpString, LPCWSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global WritePrivateProfileSectionW "WritePrivateProfileSectionW" wstr, wstr, wstr
; res = WritePrivateProfileSectionW(lpAppName, lpString, lpFileName)
; lpAppName : LPCWSTR optional -> "wstr"
; lpString : LPCWSTR optional -> "wstr"
; lpFileName : LPCWSTR optional -> "wstr"

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWritePrivateProfileSectionW = kernel32.NewProc("WritePrivateProfileSectionW")
)

// lpAppName (LPCWSTR optional), lpString (LPCWSTR optional), lpFileName (LPCWSTR optional)
r1, _, err := procWritePrivateProfileSectionW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpAppName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function WritePrivateProfileSectionW(
  lpAppName: PWideChar;   // LPCWSTR optional
  lpString: PWideChar;   // LPCWSTR optional
  lpFileName: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WritePrivateProfileSectionW';

result := DllCall("KERNEL32\WritePrivateProfileSectionW"
    , "WStr", lpAppName   ; LPCWSTR optional
    , "WStr", lpString   ; LPCWSTR optional
    , "WStr", lpFileName   ; LPCWSTR optional
    , "Int")   ; return: BOOL

●WritePrivateProfileSectionW(lpAppName, lpString, lpFileName) = DLL("KERNEL32.dll", "bool WritePrivateProfileSectionW(char*, char*, char*)")
# 呼び出し: WritePrivateProfileSectionW(lpAppName, lpString, lpFileName)
# lpAppName : LPCWSTR optional -> "char*"
# lpString : LPCWSTR optional -> "char*"
# lpFileName : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。

const std = @import("std");

extern "kernel32" fn WritePrivateProfileSectionW(
    lpAppName: [*c]const u16, // LPCWSTR optional
    lpString: [*c]const u16, // LPCWSTR optional
    lpFileName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc WritePrivateProfileSectionW(
    lpAppName: WideCString,  # LPCWSTR optional
    lpString: WideCString,  # LPCWSTR optional
    lpFileName: WideCString  # LPCWSTR optional
): int32 {.importc: "WritePrivateProfileSectionW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "kernel32");
extern(Windows)
int WritePrivateProfileSectionW(
    const(wchar)* lpAppName,   // LPCWSTR optional
    const(wchar)* lpString,   // LPCWSTR optional
    const(wchar)* lpFileName   // LPCWSTR optional
);

ccall((:WritePrivateProfileSectionW, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, Cwstring),
      lpAppName, lpString, lpFileName)
# lpAppName : LPCWSTR optional -> Cwstring
# lpString : LPCWSTR optional -> Cwstring
# lpFileName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

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

const lib = Deno.dlopen("KERNEL32.dll", {
  WritePrivateProfileSectionW: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.WritePrivateProfileSectionW(lpAppName, lpString, lpFileName)
// lpAppName : LPCWSTR optional -> "buffer"
// lpString : LPCWSTR optional -> "buffer"
// lpFileName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t WritePrivateProfileSectionW(
    const uint16_t* lpAppName,
    const uint16_t* lpString,
    const uint16_t* lpFileName);
C, "KERNEL32.dll");
// $ffi->WritePrivateProfileSectionW(lpAppName, lpString, lpFileName);
// lpAppName : LPCWSTR optional
// lpString : LPCWSTR optional
// lpFileName : 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 WritePrivateProfileSectionW(
        WString lpAppName,   // LPCWSTR optional
        WString lpString,   // LPCWSTR optional
        WString lpFileName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

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

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

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

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

open Ctypes
open Foreign

let writeprivateprofilesectionw =
  foreign "WritePrivateProfileSectionW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* lpAppName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpString : LPCWSTR optional -> (ptr uint16_t) *)
(* lpFileName : 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 ("WritePrivateProfileSectionW" write-private-profile-section-w :convention :stdcall) :int32
  (lp-app-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-string (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-file-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $WritePrivateProfileSectionW = Win32::API::More->new('KERNEL32',
    'BOOL WritePrivateProfileSectionW(LPCWSTR lpAppName, LPCWSTR lpString, LPCWSTR lpFileName)');
# my $ret = $WritePrivateProfileSectionW->Call($lpAppName, $lpString, $lpFileName);
# lpAppName : LPCWSTR optional -> LPCWSTR
# lpString : LPCWSTR optional -> LPCWSTR
# lpFileName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

WritePrivateProfileSectionW

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目