ホーム › 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
);

パラメーター

名前	型	方向	説明
lpAppName	LPCSTR	inoptional	キーを含むセクションの名前。このパラメーターが NULL の場合、関数はファイル内のすべてのセクション名を指定されたバッファーにコピーします。
lpKeyName	LPCSTR	inoptional	関連付けられた文字列を取得するキーの名前。このパラメーターが NULL の場合、関数は指定されたセクション内のすべてのキーを指定されたバッファーにコピーします。各文字列の後には null 文字が続き、最後の文字列の後にはもう 1 つの null 文字が続きます。
lpDefault	LPCSTR	inoptional	既定の文字列。初期化ファイル内に lpKeyName キーが見つからない場合、 GetProfileString は既定の文字列を lpReturnedString バッファーにコピーします。このパラメーターが NULL の場合、既定値は空の文字列 "" になります。末尾に空白文字を含む既定の文字列は指定しないでください。関数は末尾の空白を取り除くために、lpReturnedString バッファーに null 文字を挿入します。
lpReturnedString	LPSTR	outoptional	文字列を受け取るバッファーへのポインター。
nSize	DWORD	in	lpReturnedString パラメーターが指すバッファーのサイズ (文字数単位)。

戻り値の型: DWORD

公式ドキュメント

Win.ini ファイルの指定されたセクション内で、キーに関連付けられた文字列を取得します。(ANSI)

戻り値

戻り値は、バッファーにコピーされた文字数です (null 終端文字は含みません)。

lpAppName と lpKeyName のいずれも NULL ではなく、指定されたコピー先バッファーが要求された文字列を格納するには小さすぎる場合、文字列は切り詰められて null 文字が続き、戻り値は nSize から 1 を引いた値になります。

lpAppName または lpKeyName のいずれかが NULL であり、指定されたコピー先バッファーがすべての文字列を格納するには小さすぎる場合、最後の文字列は切り詰められて 2 つの null 文字が続きます。この場合、戻り値は nSize から 2 を引いた値になります。

解説(Remarks)

lpKeyName パラメーターに関連付けられた文字列が単一引用符または二重引用符で囲まれている場合、 GetProfileString 関数が文字列を返すときにその引用符は破棄されます。

GetProfileString 関数は大文字と小文字を区別しません。文字列には大文字と小文字が混在していてもかまいません。

Win.ini ファイル内のセクションは、次の形式である必要があります。

[section]
key=string
      .
      .
      .

アプリケーションは、 GetPrivateProfileString 関数を使用して、指定した初期化ファイルから文字列を取得できます。

lpDefault パラメーターは、文字列が空である場合 (つまり最初の文字が null 文字である場合) でも、有効な文字列を指している必要があります。

Windows Server 2003 および Windows XP/2000: プロファイル関数の呼び出しは、初期化ファイルではなくレジストリにマップされることがあります。このマッピングは、初期化ファイルとセクションがレジストリの次のキーの下に指定されている場合に発生します。

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows NT\CurrentVersion\IniFileMapping

操作がマップされている場合、 GetProfileString 関数は初期化ファイルではなくレジストリから情報を取得します。格納場所が変わっても、関数の動作に影響はありません。

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

IniFileMapping キーの下のレジストリで、初期化ファイルの名前を探します。
lpAppName で指定されたセクション名を探します。これは、初期化ファイルの名前を持つキーの下にある名前付きの値、またはその名前のサブキーです。あるいは、値としてもサブキーとしても存在しない場合があります。
lpAppName で指定されたセクション名が名前付きの値である場合、その値は、そのセクションのキーがレジストリ内のどこにあるかを示します。
lpAppName で指定されたセクション名がサブキーである場合、そのサブキーの下にある名前付きの値が、そのセクションのキーがレジストリ内のどこにあるかを示します。探しているキーが名前付きの値として存在しない場合は、そのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) があります。
lpAppName で指定されたセクション名が名前付きの値としてもサブキーとしても存在しない場合は、そのセクションのキーが見つかるレジストリ内の既定の場所を示す、名前のない値 (<No Name> と表示されます) があります。
セクション名に対応するサブキーもエントリもない場合は、ディスク上の実際の初期化ファイルを探し、その内容を読み取ります。

他のレジストリの場所を指定するレジストリ値を参照する際、.ini ファイルのマッピングの動作を変更するプレフィックスがいくつかあります。

! - この文字は、すべての書き込みをレジストリとディスク上の .ini ファイルの両方に対して行うよう強制します。
# - この文字は、セットアップ後に新しいユーザーが初めてログオンしたときに、レジストリ値を Windows 3.1 の .ini ファイル内の値に設定します。
@ - この文字は、要求されたデータがレジストリに見つからない場合でも、ディスク上の .ini ファイルからの読み取りが行われないようにします。
USR: - このプレフィックスは HKEY_CURRENT_USER を表し、プレフィックスの後のテキストはそのキーからの相対パスになります。
SYS: - このプレフィックスは HKEY_LOCAL_MACHINE\SOFTWARE を表し、プレフィックスの後のテキストはそのキーからの相対パスになります。

メモ

winbase.h ヘッダーは、GetProfileString を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコードに依存しないエイリアスの使用と、エンコードに依存するコードを混在させると、不整合が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 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 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetProfileStringA "GetProfileStringA" str, str, str, sptr, int
; res = GetProfileStringA(lpAppName, lpKeyName, lpDefault, varptr(lpReturnedString), nSize)
; lpAppName : LPCSTR optional -> "str"
; lpKeyName : LPCSTR optional -> "str"
; lpDefault : LPCSTR optional -> "str"
; lpReturnedString : LPSTR optional, out -> "sptr"
; nSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。