CWinApp::GetProfileString

[アーティクル]
08/09/2011

アプリケーションのレジストリまたは .INI ファイルの指定のセクションのエントリから文字列を取得します。

CString GetProfileString(
   LPCTSTR lpszSection,
   LPCTSTR lpszEntry,
   LPCTSTR lpszDefault = NULL 
);

パラメーター

lpszSection
エントリがあるセクションを指定する NULL で終わる文字列へのポインター。
lpszEntry
文字列を取得するエントリを示す NULL で終わる文字列へのポインター。 NULL を指定することはできません。
lpszDefault
初期設定ファイルにエントリが見つからなかったときの、既定の文字列値へのポインター。

戻り値

アプリケーションの .INI ファイルから文字列を返します。エントリが見つからなかった場合は、lpszDefault の値を返します。フレームワークがサポートしている文字列の最大長は、_MAX_PATH です。 lpszDefault に NULL が指定されている場合は、空の文字列を返します。

解説

セキュリティに関するメモ
この関数が返すデータは、NULL で終わるデータとは限らないため、呼び出し元で検証を行う必要があります。詳細については、「Avoiding Buffer Overruns」を参照してください。

使用例

CWinApp* pApp = AfxGetApp();

CString strSection       = _T("My Section");
CString strStringItem    = _T("My String Item");
CString strIntItem       = _T("My Int Item");

pApp->WriteProfileString(strSection, strStringItem, _T("test"));

CString strValue;
strValue = pApp->GetProfileString(strSection, strStringItem);
ASSERT(strValue == _T("test"));

pApp->WriteProfileInt(strSection, strIntItem, 1234);

int nValue;
nValue = pApp->GetProfileInt(strSection, strIntItem, 0);
ASSERT(nValue == 1234);

ほかの例については、「CWinApp::GetProfileInt」の例を参照してください。