GetProfileString

GetProfileString

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字符中止

CWinApp成员函数

CWinApp::GetProfileString

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

返回值

返回值是应用程序的.INI文件中的字符串，如果找不到该字符串，则为lpszDefault。框架支持的字符串最大长度为_MAX_PATH。如果lpszDefault为NULL，则返回值是一个空字符串。

参数： lpszSection 指向一个以null结尾的字符串，指定了包含入口的部分。

lpszEntry 指向一个以null结尾的字符串，其中包含了要获取字符串的入口。这个值不能为NULL。

lpszDefault 指向给定入口的缺省字符串值，当初始化文件中找不到入口时使用该值。

说明：

调用这个函数以获得与应用程序的注册表或.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);

请参阅：

CWinApp::GetProfileInt, CWinApp::WriteProfileString, ::GetPrivateProfileString