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

GetPrivateProfileSectionNamesA

関数
指定iniファイル内の全セクション名をANSIで取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GetPrivateProfileSectionNamesA(
    LPSTR lpszReturnBuffer,   // optional
    DWORD nSize,
    LPCSTR lpFileName   // optional
);

パラメーター

名前型方向説明
lpszReturnBufferLPSTRoutoptional指定したファイルに関連付けられたセクション名を受け取るバッファーへのポインター。バッファーには 1 つ以上の null 終端文字列が格納され、最後の文字列の後には 2 つ目の null 文字が続きます。
nSizeDWORDinlpszReturnBuffer パラメーターが指すバッファーのサイズ (文字数)。
lpFileNameLPCSTRinoptional初期化ファイルの名前。このパラメーターが NULL の場合、関数は Win.ini ファイルを検索します。このパラメーターにファイルへのフルパスが含まれていない場合、システムは Windows ディレクトリ内でファイルを検索します。

戻り値の型: DWORD

公式ドキュメント

初期化ファイル内のすべてのセクションの名前を取得します。(GetPrivateProfileSectionNamesA)

戻り値

戻り値は、指定したバッファーにコピーされた文字数を示します (終端の null 文字は含みません)。指定した初期化ファイルに関連付けられたすべてのセクション名を格納するのにバッファーが十分な大きさでない場合、戻り値は nSize で指定したサイズから 2 を引いた値になります。

解説(Remarks)

この操作はアトミックです。セクション名がバッファーにコピーされている間、初期化ファイルへの更新は許可されません。

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

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

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

  1. IniFileMapping キーの下で、初期化ファイルの名前をレジストリ内から探します。
  2. lpAppName で指定されたセクション名を探します。これは、初期化ファイルの名前を持つキーの下にある名前付きの値、またはその名前のサブキーである場合があり、値としてもサブキーとしても存在しない場合もあります。
  3. lpAppName で指定されたセクション名が名前付きの値である場合、その値は、そのセクションのキーがレジストリ内のどこにあるかを示します。
  4. lpAppName で指定されたセクション名がサブキーである場合、そのサブキーの下にある名前付きの値が、そのセクションのキーがレジストリ内のどこにあるかを示します。目的のキーが名前付きの値として存在しない場合は、そのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) があります。
  5. lpAppName で指定されたセクション名が名前付きの値としてもサブキーとしても存在しない場合は、そのセクションのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) があります。
  6. セクション名に対応するサブキーやエントリが存在しない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。
他のレジストリの場所を指定するレジストリ内の値を扱う場合、.ini ファイルのマッピングの動作を変えるいくつかのプレフィックスがあります。
メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD GetPrivateProfileSectionNamesA(
    LPSTR lpszReturnBuffer,   // optional
    DWORD nSize,
    LPCSTR lpFileName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetPrivateProfileSectionNamesA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszReturnBuffer,   // LPSTR optional, out
    uint nSize,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName   // LPCSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetPrivateProfileSectionNamesA(
    <MarshalAs(UnmanagedType.LPStr)> lpszReturnBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    nSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String   ' LPCSTR optional
) As UInteger
End Function
' lpszReturnBuffer : LPSTR optional, out
' nSize : DWORD
' lpFileName : LPCSTR optional
Declare PtrSafe Function GetPrivateProfileSectionNamesA Lib "kernel32" ( _
    ByVal lpszReturnBuffer As String, _
    ByVal nSize As Long, _
    ByVal lpFileName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetPrivateProfileSectionNamesA = ctypes.windll.kernel32.GetPrivateProfileSectionNamesA
GetPrivateProfileSectionNamesA.restype = wintypes.DWORD
GetPrivateProfileSectionNamesA.argtypes = [
    wintypes.LPSTR,  # lpszReturnBuffer : LPSTR optional, out
    wintypes.DWORD,  # nSize : DWORD
    wintypes.LPCSTR,  # lpFileName : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetPrivateProfileSectionNamesA = Fiddle::Function.new(
  lib['GetPrivateProfileSectionNamesA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszReturnBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetPrivateProfileSectionNamesA(
        lpszReturnBuffer: *mut u8,  // LPSTR optional, out
        nSize: u32,  // DWORD
        lpFileName: *const u8  // LPCSTR optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern uint GetPrivateProfileSectionNamesA([MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszReturnBuffer, uint nSize, [MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetPrivateProfileSectionNamesA' -Namespace Win32 -PassThru
# $api::GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
#uselib "KERNEL32.dll"
#func global GetPrivateProfileSectionNamesA "GetPrivateProfileSectionNamesA" sptr, sptr, sptr
; GetPrivateProfileSectionNamesA varptr(lpszReturnBuffer), nSize, lpFileName   ; 戻り値は stat
; lpszReturnBuffer : LPSTR optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; lpFileName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileSectionNamesA "GetPrivateProfileSectionNamesA" var, int, str
; res = GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
; lpszReturnBuffer : LPSTR optional, out -> "var"
; nSize : DWORD -> "int"
; lpFileName : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetPrivateProfileSectionNamesA(LPSTR lpszReturnBuffer, DWORD nSize, LPCSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileSectionNamesA "GetPrivateProfileSectionNamesA" var, int, str
; res = GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
; lpszReturnBuffer : LPSTR optional, out -> "var"
; nSize : DWORD -> "int"
; lpFileName : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetPrivateProfileSectionNamesA = kernel32.NewProc("GetPrivateProfileSectionNamesA")
)

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

extern "kernel32" fn GetPrivateProfileSectionNamesA(
    lpszReturnBuffer: [*c]u8, // LPSTR optional, out
    nSize: u32, // DWORD
    lpFileName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc GetPrivateProfileSectionNamesA(
    lpszReturnBuffer: ptr char,  # LPSTR optional, out
    nSize: uint32,  # DWORD
    lpFileName: cstring  # LPCSTR optional
): uint32 {.importc: "GetPrivateProfileSectionNamesA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetPrivateProfileSectionNamesA(
    char* lpszReturnBuffer,   // LPSTR optional, out
    uint nSize,   // DWORD
    const(char)* lpFileName   // LPCSTR optional
);
ccall((:GetPrivateProfileSectionNamesA, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{UInt8}, UInt32, Cstring),
      lpszReturnBuffer, nSize, lpFileName)
# lpszReturnBuffer : LPSTR optional, out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# lpFileName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetPrivateProfileSectionNamesA(
    char* lpszReturnBuffer,
    uint32_t nSize,
    const char* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
-- lpszReturnBuffer : LPSTR optional, out
-- nSize : DWORD
-- lpFileName : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetPrivateProfileSectionNamesA = lib.func('__stdcall', 'GetPrivateProfileSectionNamesA', 'uint32_t', ['char *', 'uint32_t', 'str']);
// GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
// lpszReturnBuffer : LPSTR optional, out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// lpFileName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetPrivateProfileSectionNamesA: { parameters: ["buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName)
// lpszReturnBuffer : LPSTR optional, out -> "buffer"
// nSize : DWORD -> "u32"
// lpFileName : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetPrivateProfileSectionNamesA(
    char* lpszReturnBuffer,
    uint32_t nSize,
    const char* lpFileName);
C, "KERNEL32.dll");
// $ffi->GetPrivateProfileSectionNamesA(lpszReturnBuffer, nSize, lpFileName);
// lpszReturnBuffer : LPSTR optional, out
// nSize : DWORD
// 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);
    int GetPrivateProfileSectionNamesA(
        byte[] lpszReturnBuffer,   // LPSTR optional, out
        int nSize,   // DWORD
        String lpFileName   // LPCSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetPrivateProfileSectionNamesA = GetPrivateProfileSectionNamesA(
    lpszReturnBuffer : UInt8*,   # LPSTR optional, out
    nSize : UInt32,   # DWORD
    lpFileName : UInt8*   # LPCSTR optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetPrivateProfileSectionNamesANative = Uint32 Function(Pointer<Utf8>, Uint32, Pointer<Utf8>);
typedef GetPrivateProfileSectionNamesADart = int Function(Pointer<Utf8>, int, Pointer<Utf8>);
final GetPrivateProfileSectionNamesA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetPrivateProfileSectionNamesANative, GetPrivateProfileSectionNamesADart>('GetPrivateProfileSectionNamesA');
// lpszReturnBuffer : LPSTR optional, out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// lpFileName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetPrivateProfileSectionNamesA(
  lpszReturnBuffer: PAnsiChar;   // LPSTR optional, out
  nSize: DWORD;   // DWORD
  lpFileName: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileSectionNamesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetPrivateProfileSectionNamesA"
  c_GetPrivateProfileSectionNamesA :: CString -> Word32 -> CString -> IO Word32
-- lpszReturnBuffer : LPSTR optional, out -> CString
-- nSize : DWORD -> Word32
-- lpFileName : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getprivateprofilesectionnamesa =
  foreign "GetPrivateProfileSectionNamesA"
    (string @-> uint32_t @-> string @-> returning uint32_t)
(* lpszReturnBuffer : LPSTR optional, out -> string *)
(* nSize : DWORD -> uint32_t *)
(* 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 ("GetPrivateProfileSectionNamesA" get-private-profile-section-names-a :convention :stdcall) :uint32
  (lpsz-return-buffer :pointer)   ; LPSTR optional, out
  (n-size :uint32)   ; DWORD
  (lp-file-name :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPrivateProfileSectionNamesA = Win32::API::More->new('KERNEL32',
    'DWORD GetPrivateProfileSectionNamesA(LPSTR lpszReturnBuffer, DWORD nSize, LPCSTR lpFileName)');
# my $ret = $GetPrivateProfileSectionNamesA->Call($lpszReturnBuffer, $nSize, $lpFileName);
# lpszReturnBuffer : LPSTR optional, out -> LPSTR
# nSize : DWORD -> DWORD
# lpFileName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目