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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

指定した初期化ファイル内の指定セクションから文字列を取得します。(GetPrivateProfileStringA)

戻り値

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

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

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

lpFileName で指定された初期化ファイルが見つからない場合、または無効な値が含まれている場合、この関数は errorno に '0x2' (File Not Found) の値を設定します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

GetPrivateProfileString 関数は、指定した初期化ファイル内で、lpAppName パラメーターで指定されたセクション見出しの下から、lpKeyName パラメーターで指定された名前と一致するキーを検索します。キーが見つかった場合、この関数は対応する文字列をバッファーにコピーします。キーが存在しない場合は、lpDefault パラメーターで指定された既定の文字列をコピーします。初期化ファイル内のセクションは、次の形式である必要があります。

[section]
key=string
      .
      .
      .

lpAppName が NULL の場合、 GetPrivateProfileString は、指定したファイル内のすべてのセクション名を、指定されたバッファーにコピーします。lpKeyName が NULL の場合、この関数は、指定したセクション内のすべてのキー名を、指定されたバッファーにコピーします。アプリケーションはこの方法を使用して、ファイル内のすべてのセクションとキーを列挙できます。いずれの場合も、各文字列の後には null 文字が続き、最後の文字列の後にはもう 1 つの null 文字が続きます。指定されたコピー先バッファーがすべての文字列を格納するには小さすぎる場合、最後の文字列は切り詰められ、2 つの null 文字が付加されます。

lpKeyName に関連付けられた文字列が単一引用符または二重引用符で囲まれている場合、 GetPrivateProfileString 関数が文字列を取得する際に、その引用符は破棄されます。

GetPrivateProfileString 関数は大文字と小文字を区別しません。文字列には大文字と小文字を混在させることができます。

Win.ini ファイルから文字列を取得するには、 GetProfileString 関数を使用します。

システムは、次のレジストリキーの下で定義されたマッピングを使用して、ほとんどの .ini ファイルへの参照をレジストリにマップします。HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\IniFileMapping

このマッピングは、アプリケーションが Control.ini、System.ini、Winfile.ini などのシステムコンポーネントの初期化ファイルを変更する場合に行われる可能性が高くなります。この場合、関数は初期化ファイルではなくレジストリから情報を取得しますが、格納場所が変わっても関数の動作には影響しません。

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

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 を表し、プレフィックスに続くテキストはそのキーからの相対位置になります。

例

次の例は、GetPrivateProfileString の使用方法を示しています。

// Gets a profile string called "Preferred line" and converts it to an int.
GetPrivateProfileString (
      "Preference",
      "Preferred Line",
      gszNULL, 
      szBuffer,
      MAXBUFSIZE,
      gszINIfilename
);

// if szBuffer is not empty.
if ( lstrcmp ( gszNULL, szBuffer ) )
{
      dwPreferredPLID = (DWORD) atoi( szBuffer );	
}
else	
{
      dwPreferredPLID = (DWORD) -1;
}

メモ

winbase.h ヘッダーは GetPrivateProfileString を、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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