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

GetPrivateProfileSectionA

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

シグネチャ

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

DWORD GetPrivateProfileSectionA(
    LPCSTR lpAppName,
    LPSTR lpReturnedString,   // optional
    DWORD nSize,
    LPCSTR lpFileName   // optional
);

パラメーター

名前方向説明
lpAppNameLPCSTRin値を取得する対象のセクション名を指す。角括弧は付けない。
lpReturnedStringLPSTRoutoptionalセクション内の全キー=値ペアを受け取るバッファ。各文字列はNULで区切られ、末尾は二重NULで終わる。
nSizeDWORDinlpReturnedStringバッファのサイズを文字数で指定する。
lpFileNameLPCSTRinoptional対象INIファイルのパス。フルパスでない場合はWindowsディレクトリが検索される。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetPrivateProfileSectionA(
    LPCSTR lpAppName,
    LPSTR lpReturnedString,   // optional
    DWORD nSize,
    LPCSTR lpFileName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetPrivateProfileSectionA(
    [MarshalAs(UnmanagedType.LPStr)] string lpAppName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpReturnedString,   // LPSTR optional, out
    uint nSize,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpFileName   // LPCSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetPrivateProfileSectionA(
    <MarshalAs(UnmanagedType.LPStr)> lpAppName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpReturnedString As System.Text.StringBuilder,   ' LPSTR optional, out
    nSize As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpFileName As String   ' LPCSTR optional
) As UInteger
End Function
' lpAppName : LPCSTR
' lpReturnedString : LPSTR optional, out
' nSize : DWORD
' lpFileName : LPCSTR optional
Declare PtrSafe Function GetPrivateProfileSectionA Lib "kernel32" ( _
    ByVal lpAppName As String, _
    ByVal lpReturnedString 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

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

lib = Fiddle.dlopen('KERNEL32.dll')
GetPrivateProfileSectionA = Fiddle::Function.new(
  lib['GetPrivateProfileSectionA'],
  [
    Fiddle::TYPE_VOIDP,  # lpAppName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpReturnedString : LPSTR optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetPrivateProfileSectionA(
        lpAppName: *const u8,  // LPCSTR
        lpReturnedString: *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 GetPrivateProfileSectionA([MarshalAs(UnmanagedType.LPStr)] string lpAppName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpReturnedString, uint nSize, [MarshalAs(UnmanagedType.LPStr)] string lpFileName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetPrivateProfileSectionA' -Namespace Win32 -PassThru
# $api::GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
#uselib "KERNEL32.dll"
#func global GetPrivateProfileSectionA "GetPrivateProfileSectionA" sptr, sptr, sptr, sptr
; GetPrivateProfileSectionA lpAppName, varptr(lpReturnedString), nSize, lpFileName   ; 戻り値は stat
; lpAppName : LPCSTR -> "sptr"
; lpReturnedString : LPSTR optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; lpFileName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileSectionA "GetPrivateProfileSectionA" str, var, int, str
; res = GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
; lpAppName : LPCSTR -> "str"
; lpReturnedString : LPSTR optional, out -> "var"
; nSize : DWORD -> "int"
; lpFileName : LPCSTR optional -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetPrivateProfileSectionA(LPCSTR lpAppName, LPSTR lpReturnedString, DWORD nSize, LPCSTR lpFileName)
#uselib "KERNEL32.dll"
#cfunc global GetPrivateProfileSectionA "GetPrivateProfileSectionA" str, var, int, str
; res = GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
; lpAppName : LPCSTR -> "str"
; lpReturnedString : 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")
	procGetPrivateProfileSectionA = kernel32.NewProc("GetPrivateProfileSectionA")
)

// lpAppName (LPCSTR), lpReturnedString (LPSTR optional, out), nSize (DWORD), lpFileName (LPCSTR optional)
r1, _, err := procGetPrivateProfileSectionA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpAppName))),
	uintptr(lpReturnedString),
	uintptr(nSize),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpFileName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetPrivateProfileSectionA(
  lpAppName: PAnsiChar;   // LPCSTR
  lpReturnedString: PAnsiChar;   // LPSTR optional, out
  nSize: DWORD;   // DWORD
  lpFileName: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileSectionA';
result := DllCall("KERNEL32\GetPrivateProfileSectionA"
    , "AStr", lpAppName   ; LPCSTR
    , "Ptr", lpReturnedString   ; LPSTR optional, out
    , "UInt", nSize   ; DWORD
    , "AStr", lpFileName   ; LPCSTR optional
    , "UInt")   ; return: DWORD
●GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName) = DLL("KERNEL32.dll", "dword GetPrivateProfileSectionA(char*, char*, dword, char*)")
# 呼び出し: GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
# lpAppName : LPCSTR -> "char*"
# lpReturnedString : 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 GetPrivateProfileSectionA(
    lpAppName: [*c]const u8, // LPCSTR
    lpReturnedString: [*c]u8, // LPSTR optional, out
    nSize: u32, // DWORD
    lpFileName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc GetPrivateProfileSectionA(
    lpAppName: cstring,  # LPCSTR
    lpReturnedString: ptr char,  # LPSTR optional, out
    nSize: uint32,  # DWORD
    lpFileName: cstring  # LPCSTR optional
): uint32 {.importc: "GetPrivateProfileSectionA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint GetPrivateProfileSectionA(
    const(char)* lpAppName,   // LPCSTR
    char* lpReturnedString,   // LPSTR optional, out
    uint nSize,   // DWORD
    const(char)* lpFileName   // LPCSTR optional
);
ccall((:GetPrivateProfileSectionA, "KERNEL32.dll"), stdcall, UInt32,
      (Cstring, Ptr{UInt8}, UInt32, Cstring),
      lpAppName, lpReturnedString, nSize, lpFileName)
# lpAppName : LPCSTR -> Cstring
# lpReturnedString : LPSTR optional, out -> Ptr{UInt8}
# nSize : DWORD -> UInt32
# lpFileName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetPrivateProfileSectionA(
    const char* lpAppName,
    char* lpReturnedString,
    uint32_t nSize,
    const char* lpFileName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
-- lpAppName : LPCSTR
-- lpReturnedString : 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 GetPrivateProfileSectionA = lib.func('__stdcall', 'GetPrivateProfileSectionA', 'uint32_t', ['str', 'char *', 'uint32_t', 'str']);
// GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
// lpAppName : LPCSTR -> 'str'
// lpReturnedString : LPSTR optional, out -> 'char *'
// nSize : DWORD -> 'uint32_t'
// lpFileName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetPrivateProfileSectionA: { parameters: ["buffer", "buffer", "u32", "buffer"], result: "u32" },
});
// lib.symbols.GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName)
// lpAppName : LPCSTR -> "buffer"
// lpReturnedString : 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 GetPrivateProfileSectionA(
    const char* lpAppName,
    char* lpReturnedString,
    uint32_t nSize,
    const char* lpFileName);
C, "KERNEL32.dll");
// $ffi->GetPrivateProfileSectionA(lpAppName, lpReturnedString, nSize, lpFileName);
// lpAppName : LPCSTR
// lpReturnedString : 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 GetPrivateProfileSectionA(
        String lpAppName,   // LPCSTR
        byte[] lpReturnedString,   // LPSTR optional, out
        int nSize,   // DWORD
        String lpFileName   // LPCSTR optional
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetPrivateProfileSectionA = GetPrivateProfileSectionA(
    lpAppName : UInt8*,   # LPCSTR
    lpReturnedString : 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 GetPrivateProfileSectionANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Utf8>);
typedef GetPrivateProfileSectionADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>);
final GetPrivateProfileSectionA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetPrivateProfileSectionANative, GetPrivateProfileSectionADart>('GetPrivateProfileSectionA');
// lpAppName : LPCSTR -> Pointer<Utf8>
// lpReturnedString : LPSTR optional, out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// lpFileName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetPrivateProfileSectionA(
  lpAppName: PAnsiChar;   // LPCSTR
  lpReturnedString: PAnsiChar;   // LPSTR optional, out
  nSize: DWORD;   // DWORD
  lpFileName: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetPrivateProfileSectionA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getprivateprofilesectiona =
  foreign "GetPrivateProfileSectionA"
    (string @-> string @-> uint32_t @-> string @-> returning uint32_t)
(* lpAppName : LPCSTR -> string *)
(* lpReturnedString : 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 ("GetPrivateProfileSectionA" get-private-profile-section-a :convention :stdcall) :uint32
  (lp-app-name :string)   ; LPCSTR
  (lp-returned-string :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 $GetPrivateProfileSectionA = Win32::API::More->new('KERNEL32',
    'DWORD GetPrivateProfileSectionA(LPCSTR lpAppName, LPSTR lpReturnedString, DWORD nSize, LPCSTR lpFileName)');
# my $ret = $GetPrivateProfileSectionA->Call($lpAppName, $lpReturnedString, $nSize, $lpFileName);
# lpAppName : LPCSTR -> LPCSTR
# lpReturnedString : LPSTR optional, out -> LPSTR
# nSize : DWORD -> DWORD
# lpFileName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い