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

GetProfileStringA

関数
win.iniから文字列をANSIで取得する旧式関数。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

名前方向
lpAppNameLPCSTRinoptional
lpKeyNameLPCSTRinoptional
lpDefaultLPCSTRinoptional
lpReturnedStringLPSTRoutoptional
nSizeDWORDin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetProfileStringA(
    LPCSTR lpAppName,   // optional
    LPCSTR lpKeyName,   // optional
    LPCSTR lpDefault,   // optional
    LPSTR lpReturnedString,   // optional
    DWORD nSize
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetProfileStringA(
    [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
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetProfileStringA(
    <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
) As UInteger
End Function
' lpAppName : LPCSTR optional
' lpKeyName : LPCSTR optional
' lpDefault : LPCSTR optional
' lpReturnedString : LPSTR optional, out
' nSize : DWORD
Declare PtrSafe Function GetProfileStringA Lib "kernel32" ( _
    ByVal lpAppName As String, _
    ByVal lpKeyName As String, _
    ByVal lpDefault As String, _
    ByVal lpReturnedString As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetProfileStringA = ctypes.windll.kernel32.GetProfileStringA
GetProfileStringA.restype = wintypes.DWORD
GetProfileStringA.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
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetProfileStringA = kernel32.NewProc("GetProfileStringA")
)

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