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
);

パラメーター

名前方向
lpAppNameLPCSTRinoptional
lpKeyNameLPCSTRinoptional
lpDefaultLPCSTRinoptional
lpReturnedStringLPSTRoutoptional
nSizeDWORDin
lpFileNameLPCSTRinoptional

戻り値の型: 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)。