ホーム › System.WindowsProgramming › GetPrivateProfileSectionNamesW
GetPrivateProfileSectionNamesW
関数指定iniファイル内の全セクション名をUnicodeで取得する。
シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
DWORD GetPrivateProfileSectionNamesW(
LPWSTR lpszReturnBuffer, // optional
DWORD nSize,
LPCWSTR lpFileName // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpszReturnBuffer | LPWSTR | outoptional | 指定されたファイルに関連付けられているセクション名を受け取るバッファーへのポインター。バッファーは 1 つ以上の null 終端文字列で満たされ、最後の文字列の後には 2 つ目の null 文字が続きます。 |
| nSize | DWORD | in | lpszReturnBuffer パラメーターが指すバッファーのサイズ (文字数)。 |
| lpFileName | LPCWSTR | inoptional | 初期化ファイルの名前。このパラメーターが NULL の場合、関数は Win.ini ファイルを検索します。このパラメーターにファイルへの完全なパスが含まれていない場合、システムは Windows ディレクトリ内でそのファイルを検索します。 |
戻り値の型: DWORD
公式ドキュメント
GetPrivateProfileSectionNamesW (Unicode) 関数 (winbase.h) は、初期化ファイル内のすべてのセクションの名前を取得します。
戻り値
戻り値は、指定されたバッファーにコピーされた文字数を示します (終端の null 文字は含みません)。指定された初期化ファイルに関連付けられているすべてのセクション名を格納するにはバッファーが十分な大きさでない場合、戻り値は nSize で指定されたサイズから 2 を引いた値になります。
解説(Remarks)
この操作はアトミックです。セクション名がバッファーにコピーされている間は、初期化ファイルへの更新は許可されません。
システムは、ほとんどの .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 ファイルの両方に対して強制的に行わせます。
- # - この文字は、セットアップ後に新しいユーザーが初めてログオンしたときに、レジストリ値が Windows 3.1 の .ini ファイル内の値に設定されるようにします。
- @ - この文字は、要求されたデータがレジストリ内に見つからない場合でも、ディスク上の .ini ファイルからの読み取りが行われないようにします。
- USR: - このプレフィックスは HKEY_CURRENT_USER を表し、プレフィックスより後のテキストはそのキーからの相対パスになります。
- SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWARE を表し、プレフィックスより後のテキストはそのキーからの相対パスになります。
メモ
winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、GetPrivateProfileSectionNames を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると不一致が生じ、コンパイルエラーや実行時エラーの原因になることがあります。詳細については、関数プロトタイプの規則を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
DWORD GetPrivateProfileSectionNamesW(
LPWSTR lpszReturnBuffer, // optional
DWORD nSize,
LPCWSTR lpFileName // optional
);[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetPrivateProfileSectionNamesW(
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszReturnBuffer, // LPWSTR optional, out
uint nSize, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] string lpFileName // LPCWSTR optional
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetPrivateProfileSectionNamesW(
<MarshalAs(UnmanagedType.LPWStr)> lpszReturnBuffer As System.Text.StringBuilder, ' LPWSTR optional, out
nSize As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> lpFileName As String ' LPCWSTR optional
) As UInteger
End Function' lpszReturnBuffer : LPWSTR optional, out
' nSize : DWORD
' lpFileName : LPCWSTR optional
Declare PtrSafe Function GetPrivateProfileSectionNamesW Lib "kernel32" ( _
ByVal lpszReturnBuffer As LongPtr, _
ByVal nSize As Long, _
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
GetPrivateProfileSectionNamesW = ctypes.windll.kernel32.GetPrivateProfileSectionNamesW
GetPrivateProfileSectionNamesW.restype = wintypes.DWORD
GetPrivateProfileSectionNamesW.argtypes = [
wintypes.LPWSTR, # lpszReturnBuffer : LPWSTR optional, out
wintypes.DWORD, # nSize : DWORD
wintypes.LPCWSTR, # lpFileName : LPCWSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
GetPrivateProfileSectionNamesW = Fiddle::Function.new(
lib['GetPrivateProfileSectionNamesW'],
[
Fiddle::TYPE_VOIDP, # lpszReturnBuffer : LPWSTR optional, out
-Fiddle::TYPE_INT, # nSize : DWORD
Fiddle::TYPE_VOIDP, # lpFileName : LPCWSTR optional
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn GetPrivateProfileSectionNamesW(
lpszReturnBuffer: *mut u16, // LPWSTR optional, out
nSize: u32, // DWORD
lpFileName: *const u16 // LPCWSTR optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern uint GetPrivateProfileSectionNamesW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszReturnBuffer, uint nSize, [MarshalAs(UnmanagedType.LPWStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetPrivateProfileSectionNamesW' -Namespace Win32 -PassThru
# $api::GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName)#uselib "KERNEL32.dll"
#func global GetPrivateProfileSectionNamesW "GetPrivateProfileSectionNamesW" wptr, wptr, wptr
; GetPrivateProfileSectionNamesW varptr(lpszReturnBuffer), nSize, lpFileName ; 戻り値は stat
; lpszReturnBuffer : LPWSTR optional, out -> "wptr"
; nSize : DWORD -> "wptr"
; lpFileName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global GetPrivateProfileSectionNamesW "GetPrivateProfileSectionNamesW" var, int, wstr ; res = GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName) ; lpszReturnBuffer : LPWSTR optional, out -> "var" ; nSize : DWORD -> "int" ; lpFileName : LPCWSTR optional -> "wstr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global GetPrivateProfileSectionNamesW "GetPrivateProfileSectionNamesW" sptr, int, wstr ; res = GetPrivateProfileSectionNamesW(varptr(lpszReturnBuffer), nSize, lpFileName) ; lpszReturnBuffer : LPWSTR optional, out -> "sptr" ; nSize : DWORD -> "int" ; lpFileName : LPCWSTR optional -> "wstr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD GetPrivateProfileSectionNamesW(LPWSTR lpszReturnBuffer, DWORD nSize, LPCWSTR lpFileName) #uselib "KERNEL32.dll" #cfunc global GetPrivateProfileSectionNamesW "GetPrivateProfileSectionNamesW" var, int, wstr ; res = GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName) ; lpszReturnBuffer : LPWSTR optional, out -> "var" ; nSize : DWORD -> "int" ; lpFileName : LPCWSTR optional -> "wstr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD GetPrivateProfileSectionNamesW(LPWSTR lpszReturnBuffer, DWORD nSize, LPCWSTR lpFileName) #uselib "KERNEL32.dll" #cfunc global GetPrivateProfileSectionNamesW "GetPrivateProfileSectionNamesW" intptr, int, wstr ; res = GetPrivateProfileSectionNamesW(varptr(lpszReturnBuffer), nSize, lpFileName) ; lpszReturnBuffer : LPWSTR optional, out -> "intptr" ; nSize : DWORD -> "int" ; lpFileName : LPCWSTR optional -> "wstr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procGetPrivateProfileSectionNamesW = kernel32.NewProc("GetPrivateProfileSectionNamesW")
)
// lpszReturnBuffer (LPWSTR optional, out), nSize (DWORD), lpFileName (LPCWSTR optional)
r1, _, err := procGetPrivateProfileSectionNamesW.Call(
uintptr(lpszReturnBuffer),
uintptr(nSize),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpFileName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GetPrivateProfileSectionNamesW(
lpszReturnBuffer: PWideChar; // LPWSTR optional, out
nSize: DWORD; // DWORD
lpFileName: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetPrivateProfileSectionNamesW';result := DllCall("KERNEL32\GetPrivateProfileSectionNamesW"
, "Ptr", lpszReturnBuffer ; LPWSTR optional, out
, "UInt", nSize ; DWORD
, "WStr", lpFileName ; LPCWSTR optional
, "UInt") ; return: DWORD●GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName) = DLL("KERNEL32.dll", "dword GetPrivateProfileSectionNamesW(char*, dword, char*)")
# 呼び出し: GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName)
# lpszReturnBuffer : LPWSTR optional, out -> "char*"
# nSize : DWORD -> "dword"
# 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 GetPrivateProfileSectionNamesW(
lpszReturnBuffer: [*c]u16, // LPWSTR optional, out
nSize: u32, // DWORD
lpFileName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc GetPrivateProfileSectionNamesW(
lpszReturnBuffer: ptr uint16, # LPWSTR optional, out
nSize: uint32, # DWORD
lpFileName: WideCString # LPCWSTR optional
): uint32 {.importc: "GetPrivateProfileSectionNamesW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
uint GetPrivateProfileSectionNamesW(
wchar* lpszReturnBuffer, // LPWSTR optional, out
uint nSize, // DWORD
const(wchar)* lpFileName // LPCWSTR optional
);ccall((:GetPrivateProfileSectionNamesW, "KERNEL32.dll"), stdcall, UInt32,
(Ptr{UInt16}, UInt32, Cwstring),
lpszReturnBuffer, nSize, lpFileName)
# lpszReturnBuffer : LPWSTR optional, out -> Ptr{UInt16}
# nSize : DWORD -> UInt32
# lpFileName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t GetPrivateProfileSectionNamesW(
uint16_t* lpszReturnBuffer,
uint32_t nSize,
const uint16_t* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName)
-- lpszReturnBuffer : LPWSTR optional, out
-- nSize : DWORD
-- 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 GetPrivateProfileSectionNamesW = lib.func('__stdcall', 'GetPrivateProfileSectionNamesW', 'uint32_t', ['uint16_t *', 'uint32_t', 'str16']);
// GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName)
// lpszReturnBuffer : LPWSTR optional, out -> 'uint16_t *'
// nSize : DWORD -> 'uint32_t'
// lpFileName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
GetPrivateProfileSectionNamesW: { parameters: ["buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName)
// lpszReturnBuffer : LPWSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// lpFileName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GetPrivateProfileSectionNamesW(
uint16_t* lpszReturnBuffer,
uint32_t nSize,
const uint16_t* lpFileName);
C, "KERNEL32.dll");
// $ffi->GetPrivateProfileSectionNamesW(lpszReturnBuffer, nSize, lpFileName);
// lpszReturnBuffer : LPWSTR optional, out
// nSize : DWORD
// 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);
int GetPrivateProfileSectionNamesW(
char[] lpszReturnBuffer, // LPWSTR optional, out
int nSize, // DWORD
WString lpFileName // LPCWSTR optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun GetPrivateProfileSectionNamesW = GetPrivateProfileSectionNamesW(
lpszReturnBuffer : UInt16*, # LPWSTR optional, out
nSize : UInt32, # DWORD
lpFileName : UInt16* # LPCWSTR optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GetPrivateProfileSectionNamesWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Utf16>);
typedef GetPrivateProfileSectionNamesWDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>);
final GetPrivateProfileSectionNamesW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<GetPrivateProfileSectionNamesWNative, GetPrivateProfileSectionNamesWDart>('GetPrivateProfileSectionNamesW');
// lpszReturnBuffer : LPWSTR optional, out -> Pointer<Utf16>
// nSize : DWORD -> Uint32
// lpFileName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetPrivateProfileSectionNamesW(
lpszReturnBuffer: PWideChar; // LPWSTR optional, out
nSize: DWORD; // DWORD
lpFileName: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'KERNEL32.dll' name 'GetPrivateProfileSectionNamesW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetPrivateProfileSectionNamesW"
c_GetPrivateProfileSectionNamesW :: CWString -> Word32 -> CWString -> IO Word32
-- lpszReturnBuffer : LPWSTR optional, out -> CWString
-- nSize : DWORD -> Word32
-- lpFileName : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getprivateprofilesectionnamesw =
foreign "GetPrivateProfileSectionNamesW"
((ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* lpszReturnBuffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* nSize : DWORD -> uint32_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 ("GetPrivateProfileSectionNamesW" get-private-profile-section-names-w :convention :stdcall) :uint32
(lpsz-return-buffer :pointer) ; LPWSTR optional, out
(n-size :uint32) ; DWORD
(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 $GetPrivateProfileSectionNamesW = Win32::API::More->new('KERNEL32',
'DWORD GetPrivateProfileSectionNamesW(LPWSTR lpszReturnBuffer, DWORD nSize, LPCWSTR lpFileName)');
# my $ret = $GetPrivateProfileSectionNamesW->Call($lpszReturnBuffer, $nSize, $lpFileName);
# lpszReturnBuffer : LPWSTR optional, out -> LPWSTR
# nSize : DWORD -> DWORD
# lpFileName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f GetPrivateProfileSectionNamesA (ANSI版) — 指定iniファイル内の全セクション名をANSIで取得する。
公式の関連項目
- f WritePrivateProfileSectionW — 指定iniファイルのセクション全体をUnicodeで書き込む。