GetProfileString

GetProfileString，計算機語言C/C++的函式。在WIN32 API中，功能是從win.ini檔案中讀取指定段和鍵的值；在CWinApp中，功能是讀出指定段名、指定入口的值。

基本介紹

• 中文名：GetProfileString
• 屬性：函式
• 詞性：名詞
• 功能：讀出指定段名、指定入口的值等

用法

聲明

Declare Function GetProfileString Lib "kernel32" Alias "GetProfileStringA" (ByVal lpAppName As String, ByVal lpKeyName As String, ByVal lpDefault As String, ByVal lpReturnedString As String, ByVal nSize As Long) As Long

說明

為win.ini初始化檔案中指定的條目取得字串則返回nSize-2）Long，裝載到lpReturnedString緩衝區的最大字元數

註解

CWinApp成員函式

CWinApp::GetProfileString

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

返回值

返回值是應用程式的.INI檔案中的字元串，如果找不到該字元串，則為lpszDefault。框架支持的字元串最大長度為_MAX_PATH。如果lpszDefault為NULL，則返回值是一個空字元串。

參數： lpszSection 指向一個以null結尾的字元串，指定了包含入口的部分。

說明

調用這個函式以獲得與應用程式的註冊表或.INI檔案中指定部分的入口相關的字元串。

這些入口按照如下方式保存：

·Windows NT 該值保存在註冊表中

·Windows 3.X 該值保存在WIN.INI檔案中

·Windows 95 該值保存在WIN.INI的緩衝版本中

示例

CString strSection = "My Section";

CString strStringItem = "My String Item";

CString strIntItem = "My Int Item";

CWinApp* pApp = AfxGetApp();

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

CString strValue;

strValue = pApp->GetProfileString(strSection, strStringItem);

ASSERT(strValue == "test");

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

int nValue;

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

ASSERT(nValue == 1234);

App

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

返回值

返回值是應用程式的.INI檔案中的字元串，如果找不到該字元串，則為lpszDefault。框架支持的字元串最大長度為_MAX_PATH。如果lpszDefault為NULL，則返回值是一個空字元串。

參數

lpszSection	指向一個以null結尾的字元串，指定了包含入口的部分。
lpszEntry	指向一個以null結尾的字元串，其中包含了要獲取字元串的入口。這個值不能為NULL。
lpszDefault	指向給定入口的預設字元串值，當初始化檔案中找不到入口時使用該值。

示例

CString str;

str = GetProfileString("SectionName", "EntryName", "defaultValue");

執行後str == "value"， 否則str=="defaultValue" 。

VB聲明

Declare Function GetProfileString Lib "kernel32" Alias "GetProfileStringA" (ByVal lpAppName As String, ByVal lpKeyName As String, ByVal lpDefault As String, ByVal lpReturnedString As String, ByVal nSize As Long) As Long
說明
為win.ini初始化檔案中指定的條目取得字串
返回值
Long，複製到lpReturnedString緩衝區的位元組數量，其中不包括那些NULL中止字元。如lpReturnedString緩衝區不夠大，不能容下全部信息，就返回nSize-1（若lpAppName或lpKeyName為NULL，則返回nSize-2）
參數表
參數	類型及說明
lpAppName	String，要在其中查找條目的小節名。這個字串不區分大小寫。如果為vbNullString，則在lpReturnedString緩衝區裝載這個.ini檔案的所有小節的一個列表
lpKeyName	String，欲獲取的項名或條目名。這個字串不區分大小寫。如果為vbNullString，則在lpReturnedString緩衝區裝載指定小節內所有項的一個列表
lpDefault	String，指定條目未找到時返回的默認值。可設為空（""）
lpReturnedString	String，指定一個預先初始化好的字串緩衝區，長度至少為nSize個字元
nSize	Long，裝載到lpReturnedString緩衝區的最大字元數
註解
如lpKeyName參數為零，那么lpReturnedString緩衝區會載入指定小節內所有設定項的一個列表。每個項都用一個NULL字元分隔，最後那個項用兩個NULL字元中止