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

GetPrivateProfileStringA

関数
指定iniファイルから文字列をANSIで取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD GetPrivateProfileStringA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpKeyName,   // optional
    LPCSTR lpDefault,   // optional
    LPSTR lpReturnedString,   // optional
    DWORD nSize,
    LPCSTR lpFileName   // optional
);

パラメーター

名前方向説明
lpAppNameLPCSTRinoptionaliniファイル内のセクション名(ANSI)。NULLで全セクション名を列挙。
lpKeyNameLPCSTRinoptional文字列を取得するキー名(ANSI)。NULLでセクション内全キー名を列挙。
lpDefaultLPCSTRinoptionalキーが見つからない場合に返す既定文字列(ANSI)。
lpReturnedStringLPSTRoutoptional取得した文字列を受け取るバッファ(ANSI)。
nSizeDWORDinバッファlpReturnedStringのサイズ(文字数)。
lpFileNameLPCSTRinoptional対象のiniファイルのパス(ANSI)。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

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

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

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

関連項目

文字セット違い