feat(tsl-api-reference): index class and unit APIs

Migrate reference pages to declaration-line storage and rebuild the
13-column index.

Add qualified member lookup plus regression and end-to-end coverage.
This commit is contained in:
csh
2026-07-29 15:47:46 +08:00
parent 9edc8fc868
commit 13be5ea0aa
239 changed files with 39157 additions and 12846 deletions
@@ -4,6 +4,8 @@
## `TSLObjects(_type)`
声明:function
获取当前运行环境下所有对象的信息。 目前仅下一代服务器与两个客户端本地解析器中支持。
旧定义:`TSLObjects(Type:Boolean):array`
@@ -20,6 +22,8 @@ Source ID33022
## `FindOverLoad(p_n, function_name, obj)`
声明:function
查找对象中的方法,支持查找重载方法。
旧定义:`FindOverLoad(pN:Integer;FunctionName:String;Obj:Object or Class)`
@@ -38,6 +42,8 @@ Source ID29867
## `SetCustomHeader(name, value)`
声明:function
设置header字段。
对象:TWebResponse
@@ -57,6 +63,8 @@ Source ID1647
## `SetCookieField(values, domain, path, expires, secure)`
声明:function
设置Cookie字段。
对象:TWebResponse
@@ -79,6 +87,8 @@ Source ID1646
## `Sent()`
声明:function
是否已发送。已经发送则设置头信息没有意义。
对象:TWebResponse
@@ -93,6 +103,8 @@ Source ID1645
## `SendStream(stream)`
声明:function
发送流。
对象:TWebResponse
@@ -111,6 +123,8 @@ Source ID1644
## `SendResponse()`
声明:function
发送响应包。
对象:TWebResponse
@@ -125,6 +139,8 @@ Source ID1643
## `SendRedirect(uri)`
声明:function
发送重定向。
对象:TWebResponse
@@ -143,6 +159,8 @@ Source ID1642
## `GetCustomHeader(name)`
声明:function
读取CustomHeaders里的内容。
对象:TWebResponse
@@ -161,6 +179,8 @@ Source ID1641
## `TranslateURI(uri)`
声明:function
将一个URI转换成服务器上可用的路径格式。
对象:TWebRequest
@@ -179,6 +199,8 @@ Source ID1696
## `GetFieldByName(name)`
声明:function
取Header的值。
对象:TWebRequest
@@ -197,6 +219,8 @@ Source ID1695
## `ExtractQueryFields(strings)`
声明:function
将Query的内容展开到列表里。
对象:TWebRequest
@@ -215,6 +239,8 @@ Source ID1694
## `ExtractCookieFields(strings)`
声明:function
将Cookie的内容展开到列表里。
对象:TWebRequest
@@ -233,6 +259,8 @@ Source ID1693
## `ExtractContentFields(strings)`
声明:function
将post的内容展开到列表里。
对象:TWebRequest
@@ -251,6 +279,8 @@ Source ID1692
## `WriteHeaders(status_code, headers)`
声明:function
向客户端发送头部。
对象:TWebRequest
@@ -270,6 +300,8 @@ Source ID1691
## `WriteString(s)`
声明:function
向客户端发送的数据。
对象:TWebRequest
@@ -288,6 +320,8 @@ Source ID1690
## `ReadString(count)`
声明:function
读取客户端发送的数据。
对象:TWebRequest
@@ -306,6 +340,8 @@ Source ID1689
## `WriteClient(buffer, count)`
声明:function
向客户端发送的数据。
对象:TWebRequest
@@ -325,6 +361,8 @@ Source ID1688
## `ReadClient(buffer, count)`
声明:function
读取客户端发送的数据。
对象:TWebRequest
@@ -344,6 +382,8 @@ Source ID1687
## `ExChange(index1, index2)`
声明:function
将两个位置的内容互相交换。
对象:TStringList
@@ -363,6 +403,8 @@ Source ID31667
## `SetText(text)`
声明:function
设置text的内容,与设置属性Text的操作相同。
对象:TStringList
@@ -381,6 +423,8 @@ Source ID1556
## `OnlineSession(id, strings)`
声明:function
获得指定用户的在线会话列表,一般用于调试用。
对象:TSessionMan
@@ -400,6 +444,8 @@ Source ID1724
## `OnlineUser(strings)`
声明:function
获得在线的ID列表。
对象:TSessionMan
@@ -418,6 +464,8 @@ Source ID1723
## `Move(cur_index, new_index)`
声明:function
将指定位置的内容移动到新位置。
对象:TStringList
@@ -437,6 +485,8 @@ Source ID1553
## `DeleteSession(id, session_id)`
声明:function
删除会话。
对象:TSessionMan
@@ -456,6 +506,8 @@ Source ID1722
## `AssignTo(des)`
声明:function
复制Cookie的内容到Des。
对象:TCookie
@@ -474,6 +526,8 @@ Source ID1716
## `GetSession(id, session_id)`
声明:function
获得一个已有的会话。
对象:TSessionMan
@@ -493,6 +547,8 @@ Source ID1721
## `AppendMessage(folder_name, msg)`
声明:function
添加邮件至指定文件夹
对象:IMAP
@@ -512,6 +568,8 @@ Source ID37947
## `HeaderValue()`
声明:function
获得Cookie在Header里的串。
对象:TCookie
@@ -526,6 +584,8 @@ Source ID1714
## `CopyMessage(folder_name, msg_id, dest_folder_name)`
声明:function
复制邮件至目标文件夹
对象:IMAP
@@ -546,6 +606,8 @@ Source ID37946
## `IndexOfName(name)`
声明:function
返回Name键值所在的索引号。
对象:TStringList
@@ -564,6 +626,8 @@ Source ID1550
## `NewSession(id, max_session)`
声明:function
新建一个会话。
对象:TSessionMan
@@ -583,6 +647,8 @@ Source ID1720
## `RetrieveMailBoxSize(folder_name)`
声明:function
对象:IMAP
旧定义:`RetrieveMailBoxSize([FolderName:String]):Integer;`
@@ -599,6 +665,8 @@ Source ID37945
## `GetText()`
声明:function
与Text属性的结果相同。
对象:TStringList
@@ -613,6 +681,8 @@ Source ID1549
## `CheckMessages(folder_name)`
声明:function
查看邮箱文件夹邮件数量
对象:IMAP
@@ -631,6 +701,8 @@ Source ID37943
## `CAPA()`
声明:function
获取服务器的支持命令列表。
对象:IMAP
@@ -645,6 +717,8 @@ Source ID37938
## `Equals(src)`
声明:function
比较两个内容是否相同。
对象:TStringList
@@ -663,6 +737,8 @@ Source ID1548
## `RenameFolder(folder_name, new_folder_name)`
声明:function
重命名邮箱文件夹
对象:IMAP
@@ -682,6 +758,8 @@ Source ID37942
## `KeepAlive()`
声明:function
发送空指令保持服务的连接。
对象:IMAP
@@ -696,6 +774,8 @@ Source ID37937
## `DeleteFolder(folder_name)`
声明:function
删除指定邮件文件夹
对象:IMAP
@@ -714,6 +794,8 @@ Source ID37941
## `Logout()`
声明:function
退出登录
对象:IMAP
@@ -728,6 +810,8 @@ Source ID37936
## `Login()`
声明:function
登录,调用前必须先设置Host、Port、Username、Password属性
对象:IMAP
@@ -742,6 +826,8 @@ Source ID37935
## `CreateFolder(folder_name)`
声明:function
新建邮箱文件夹
对象:IMAP
@@ -760,6 +846,8 @@ Source ID37940
## `Login()`
声明:function
登录,此前必须制定Username和Password属性。
对象:Pop3
@@ -774,6 +862,8 @@ Source ID29871
## `ListFolders(reference, mail_box)`
声明:function
获取邮箱文件夹的列表信息
对象:IMAP
@@ -793,6 +883,8 @@ Source ID37939
## `AddStrings(strings)`
声明:function
将Strings里的字符串批量添加。
对象:TStringList
@@ -811,6 +903,8 @@ Source ID1545
## `CAPA()`
声明:function
取服务器的支持命令列表。
对象:Pop3
@@ -825,6 +919,8 @@ Source ID1772
## `Reset()`
声明:function
复位,撤销所有本次会话中的删除操作。
对象:Pop3
@@ -839,6 +935,8 @@ Source ID1763
## `UIDL(ids)`
声明:function
取服务器的邮件唯一标示列表。
对象:Pop3
@@ -857,6 +955,8 @@ Source ID1771
## `KeepAlive()`
声明:function
发送空指令保持服务的连接。
对象:Pop3
@@ -871,6 +971,8 @@ Source ID1762
## `RetrieveRaw(msg_id, msg_content)`
声明:function
取邮件的原始内容。
对象:Pop3
@@ -890,6 +992,8 @@ Source ID1770
## `RetrieveHeader(msg_id, msg)`
声明:function
取邮件的内容,仅仅取邮件的头部信息,不取附件等内容。
对象:Pop3
@@ -909,6 +1013,8 @@ Source ID1769
## `IndexOf(s)`
声明:function
返回字符串所在的索引号。查找与大小写敏感设置有关。
对象:TStringList
@@ -927,6 +1033,8 @@ Source ID1542
## `CheckMessages()`
声明:function
返回邮件的个数。
对象:Pop3
@@ -941,6 +1049,8 @@ Source ID1761
## `Retrieve(msg_id, msg)`
声明:function
取邮件的内容。
对象:Pop3
@@ -960,6 +1070,8 @@ Source ID1768
## `DisconnectNotifyPeer()`
声明:function
断开并且通知服务器。
对象:Pop3
@@ -974,6 +1086,8 @@ Source ID1760
## `RetrieveMailBoxSize()`
声明:function
获取邮箱的大小。
对象:Pop3
@@ -988,6 +1102,8 @@ Source ID1767
## `RetrieveMsgSize(msg_id)`
声明:function
取指定邮件的大小。
对象:Pop3
@@ -1006,6 +1122,8 @@ Source ID1766
## `SendCmd(cmd, cmd_result, ret_code)`
声明:function
发送命令。
对象:Pop3
@@ -1026,6 +1144,8 @@ Source ID1757
## `SetStrings(strings)`
声明:function
设置所有内容。
对象:TMemIniFile
@@ -1044,6 +1164,8 @@ Source ID1610
## `PriDecrypt(s)`
声明:function
对字符串s的内容用私钥解密,
对象:TRSA
@@ -1062,6 +1184,8 @@ Source ID29956
## `GetStrings(strings)`
声明:function
取出所有内容。
对象:TMemIniFile
@@ -1080,6 +1204,8 @@ Source ID1609
## `PubDecrypt(s)`
声明:function
对字符串s的内容用公钥解密,
对象:TRSA
@@ -1098,6 +1224,8 @@ Source ID29955
## `PriEncrypt(s)`
声明:function
对字符串s的内容用私钥加密,
对象:TRSA
@@ -1116,6 +1244,8 @@ Source ID29954
## `DecryptFile(src_alias, src_filename, dest_alias, dest_filename)`
声明:function
对文件src_filename进行解密,加密后的内容写入dest_filename文件中。
对象:TCipher
@@ -1137,6 +1267,8 @@ Source ID29970
## `Login()`
声明:function
登录,暂不支持。但是,在设置了Username和Password属性时,使用connect()方法就包括连接服务器和登陆功能。如需验证用户名密码可使用Authenticate()方法。
对象:SMTP
@@ -1151,6 +1283,8 @@ Source ID29870
## `PubEncrypt(s)`
声明:function
对字符串s的内容用公钥加密,
对象:TRSA
@@ -1169,6 +1303,8 @@ Source ID29953
## `Decrypt(s)`
声明:function
字符串s的内容解密,返回解密后的字符串
对象:TCipher
@@ -1187,6 +1323,8 @@ Source ID29969
## `GenerateKey()`
声明:function
生成指定位数的公钥和私钥,位数必须是256的正整数倍,最大4096
对象:TRSA
@@ -1201,6 +1339,8 @@ Source ID29952
## `Expand(username)`
声明:function
展开用户名,例如用于邮件列表。需要服务器配置,暂不支持。
对象:SMTP
@@ -1219,6 +1359,8 @@ Source ID1742
## `EncryptFile(src_alias, src_filename, dest_alias, dest_filename)`
声明:function
对文件src_filename进行加密,加密后的内容写入dest_filename文件中。
对象:TCipher
@@ -1240,6 +1382,8 @@ Source ID29968
## `QuickSend(a_host, a_subject, a_to, a_from, a_text)`
声明:function
发送邮件。暂时不支持
对象:SMTP
@@ -1262,6 +1406,8 @@ Source ID1741
## `Encrypt(s)`
声明:function
对字符串s的内容加密,返回加密后的字符串
对象:TCipher
@@ -1280,6 +1426,8 @@ Source ID29967
## `Authenticate()`
声明:function
服务器验证。验证用户名和密码是否能登陆smtp服务器。使用之前需要先使用connect()方法。
对象:SMTP
@@ -1294,6 +1442,8 @@ Source ID1740
## `Send(message)`
声明:function
发送邮件。
对象:SMTP
@@ -1312,6 +1462,8 @@ Source ID1739
## `DisconnectNotifyPeer()`
声明:function
断开并且通知服务器。
对象:SMTP
@@ -1326,6 +1478,8 @@ Source ID1738
## `SendCmd(cmd, cmd_result, ret_code)`
声明:function
发送命令。
对象:SMTP
@@ -1346,6 +1500,8 @@ Source ID1735
## `ValueExists(section, ident)`
声明:function
是否存在指定的键。
对象:TIniFile
@@ -1365,6 +1521,8 @@ Source ID1604
## `SetSize(size)`
声明:function
设置大小。私有方法,实例与继承类无法访问。改变大小可通过属性Size进行赋值设置。
对象:TStream
@@ -1383,6 +1541,8 @@ Source ID1567
## `ReadDate(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1403,6 +1563,8 @@ Source ID1593
## `DeleteKey(section, ident)`
声明:function
删除指定的键。
对象:TIniFile
@@ -1422,6 +1584,8 @@ Source ID1603
## `CopyFrom(src, count)`
声明:function
复制流,复制成功后当前位置会移动Count个位置。
对象:TStream
@@ -1441,6 +1605,8 @@ Source ID1564
## `Seek(position, origin)`
声明:function
移动指针。
对象:TStream
@@ -1460,6 +1626,8 @@ Source ID1566
## `WriteBinaryStream(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1480,6 +1648,8 @@ Source ID1592
## `EraseSection(section)`
声明:function
删除章节。
对象:TIniFile
@@ -1498,6 +1668,8 @@ Source ID1602
## `ReadBinaryStream(section, ident, value)`
声明:function
读INI内容。
对象:TIniFile
@@ -1518,6 +1690,8 @@ Source ID1591
## `ReadSections(strings)`
声明:function
读INI章节的所有章节名。
对象:TIniFile
@@ -1536,6 +1710,8 @@ Source ID1601
## `WriteBoolean(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1556,6 +1732,8 @@ Source ID1590
## `ReadSectionValues(section, strings)`
声明:function
读INI章节的所有内容。
对象:TIniFile
@@ -1575,6 +1753,8 @@ Source ID1600
## `ReadBoolean(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1595,6 +1775,8 @@ Source ID1589
## `ReadSection(section, strings)`
声明:function
读INI章节的所有键名。
对象:TIniFile
@@ -1614,6 +1796,8 @@ Source ID1599
## `WriteFloat(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1634,6 +1818,8 @@ Source ID1598
## `WriteInteger(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1654,6 +1840,8 @@ Source ID1588
## `ReadFloat(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1674,6 +1862,8 @@ Source ID1597
## `ReadInteger(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1694,6 +1884,8 @@ Source ID1587
## `WriteDateTime(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1714,6 +1906,8 @@ Source ID1596
## `WriteString(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1734,6 +1928,8 @@ Source ID1586
## `ReadDateTime(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1754,6 +1950,8 @@ Source ID1595
## `ReadString(section, ident, default)`
声明:function
读INI内容。
对象:TIniFile
@@ -1774,6 +1972,8 @@ Source ID1585
## `WriteDate(section, ident, value)`
声明:function
写INI内容。
对象:TIniFile
@@ -1794,6 +1994,8 @@ Source ID1594
## `SectionExists(section)`
声明:function
是否存在指定章节名。
对象:TIniFile
@@ -1812,6 +2014,8 @@ Source ID1584
## `DisconnectNotifyPeer()`
声明:function
断开并且通知服务器。
对象:FTP
@@ -1826,6 +2030,8 @@ Source ID29882
## `SetLang(lang_tag)`
声明:function
请求以指定的语言返回响应的内容。
对象:FTP
@@ -1844,6 +2050,8 @@ Source ID29900
## `ReInitialize(delay)`
声明:function
清除FTP客户端的账户及其设置信息。
对象:FTP
@@ -1862,6 +2070,8 @@ Source ID29894
## `ChangeDirUp()`
声明:function
切换到FTP服务器上当前目录的父目录。
对象:FTP
@@ -1876,6 +2086,8 @@ Source ID29878
## `Login()`
声明:function
提供FTP连接的验证,此前必须制定Username和Password属性。
对象:FTP
@@ -1890,6 +2102,8 @@ Source ID29888
## `ChangeDir(a_dir_name)`
声明:function
改变FTP服务器上的当前目录。
对象:FTP
@@ -1908,6 +2122,8 @@ Source ID29877
## `SetCmdOpt(cmd, options)`
声明:function
指定一个在FTP命令之后的行为
对象:FTP
@@ -1927,6 +2143,8 @@ Source ID29899
## `MakeDir(dir_name)`
声明:function
在FTP服务器上创建目录。
对象:FTP
@@ -1945,6 +2163,8 @@ Source ID29889
## `Noop()`
声明:function
向FTP服务器发送一个KEEP-ALIVE信号。服务器在长时间处于空闲状态下,使用NOOP方法可以防止服务器关闭连接。
对象:FTP
@@ -1959,6 +2179,8 @@ Source ID29890
## `RetrieveCurrentDir()`
声明:function
获得服务器上当前目录的名称。
对象:FTP
@@ -1973,6 +2195,8 @@ Source ID29898
## `Rename(source_file, dest_file)`
声明:function
重命名FTP服务器指定文件。
对象:FTP
@@ -1992,6 +2216,8 @@ Source ID29896
## `ResumeSupported()`
声明:function
指出服务器上是否支持REST命令。
对象:FTP
@@ -2006,6 +2232,8 @@ Source ID29897
## `Site(command)`
声明:function
发送一个FTP服务器端的命令。
对象:FTP
@@ -2024,6 +2252,8 @@ Source ID29903
## `CRC(file_name, start_point, end_point)`
声明:function
计算FTP服务器上指定文件的CRC值。需要FTP服务器支持XCRC功能。
对象:FTP
@@ -2044,6 +2274,8 @@ Source ID31579
## `IsServerMDTZAndListTForm()`
声明:function
指出FTP服务器是否支持FTP MDTM和LIST-T 命令。
对象:FTP
@@ -2058,6 +2290,8 @@ Source ID29886
## `Help(help_contents, command)`
声明:function
获得FTP服务器命令以及其他帮助信息,使用FTP的HELP命令。必须在登陆连接后才可以使用Help函数。
对象:FTP
@@ -2077,6 +2311,8 @@ Source ID29885
## `SetModTime(file_name, local_time)`
声明:function
设置指定文件的最后修改时间。
对象:FTP
@@ -2096,6 +2332,8 @@ Source ID29901
## `Status(status_list)`
声明:function
实现FTP的STAT命令。
对象:FTP
@@ -2114,6 +2352,8 @@ Source ID29905
## `AddAttachment()`
声明:function
添加一个文件附件的消息部分。
对象:MailMsg
@@ -2128,6 +2368,8 @@ Source ID1795
## `SetModTimeGMT(file_name, gmt_time)`
声明:function
设置指定文件的最后修改时间。
对象:FTP
@@ -2147,6 +2389,8 @@ Source ID29902
## `MessagePart(index)`
声明:function
返回指定的消息部分。
对象:MailMsg
@@ -2165,6 +2409,8 @@ Source ID1794
## `SendCmd(cmd, cmd_result, ret_code)`
声明:function
发送命令。
对象:MailMsg