pascal/lazarus-ccr
1
0
Fork 0
Code Issues Releases Activity

RxFPC: documentation

Browse Source 
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@5008 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
alexs75
2016-07-20 05:53:15 +00:00
parent a06674e8c0
commit 1101949cce
2 changed files with 11 additions and 263 deletions
Download Patch File Download Diff File Expand all files Collapse all files

263
components/rx/trunk/docs/rxFileUtils.xml
View File

@ -1,263 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="rxnew">
<module name="rxFileUtils">
<element name="GetFileOwnerUser">
<short>Возвращает имя владельца файла</short>
<descr>
<p>function <b>GetFileOwnerUser</b>(const SearchDomain, FileName:<b>String</b>):<b>String</b>;
</p>
<p>Функция возвращает имя пользователя операционной системы владельца указанного файла. </p>
<p>
<b>Входные параметры:</b>
</p>
<p>SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).</p>
<p>FileName - Полное имя файла.</p>
<remark>В данный момент функция реализована только для windows.</remark>
</descr>
<seealso>
<link id="GetFileOwnerData"/>
</seealso>
</element>
<element name="GetFileOwnerData">
<short>Возвращает данные владельца файла</short>
<descr>
<p>
<b>procedure</b> GetFileOwnerData(
<b>const</b> SearchDomain, FileName:
<b>String</b>;
<b>out</b> UserName, DomainName:
<b>String</b>);
</p>
<p>Процедура возвращает имя и домен пользователя операционной системы владельца указанного файла. </p>
<p>
<b>Входные параметры:</b>
</p>
<p>- SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).</p>
<p>- FileName - Полное имя файла.</p>
<p>
<b>Выходные параметры:</b>
</p>
<p>- UserName - Имя пльзователя.</p>
<p>- DomainName - Домен, в котором найден данный пользователь.</p>
<remark>В данный момент функция реализована только для windows.</remark>
</descr>
<seealso>
<link id="GetFileOwnerData"/>
</seealso>
</element>
<element name="NormalizeDirectoryName">
<short>Функция приводит к принятому в данной ОС виду все разделители каталогов.</short>
<descr>
<p>
<b>function</b> NormalizeDirectoryName(
<b>const</b> DirName:
<b>string</b>):
<b>string</b>;</p>
<p>Функция проверяет все разделители каталогов в указанном имени файла/каталога и, если нужно, меняет их на значение константы<b>DirectorySeparator</b>.</p>
</descr>
</element>
<short>Содержит дополнительные утилиты работы с файлами и ОС</short>
<element name="GetUserName">
<short>Функция <b>GetUserName</b> возвращает имя оператора, залогиненго в системе</short>
<descr>
<p>
<b>function</b> GetUserName:
<b>string</b>;</p>
<p>Функция <b>GetUserName</b> возвращает имя оператора, залогиненго в системе</p>
</descr>
</element>
</module>
</package>
</fpdoc-descriptions>

11
components/rx/trunk/docs/rxfileutils.xml
View File

@ -5,9 +5,20 @@
</element><element name="NormalizeFileName"><short>Функция приводит имя файла к правильному виду в зависимости от платформы</short><descr><p>Данная функция проверяет все символы в имени файла и заменяет запрещённые символы на указанный <b>AReplaceChar</b>.</p><p>По умолчанию вместо AReplaceChar подставляется символ "_" (подчёркивание)</p>
</descr>
</element><element name="GetFileOwnerUser"><short>Функция возвращает имя пользователя - владельца файла</short>
<descr><p>function <b>GetFileOwnerUser</b>(const SearchDomain, FileName:<b>String</b>):<b>String</b>;</p><p>Функция возвращает имя пользователя операционной системы владельца указанного файла.</p><p><b>Входные параметры:</b>
</p><p>SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).</p><p>FileName - Полное имя файла.</p><remark>В данный момент функция реализована только для windows.</remark>
</descr>
</element><element name="GetFileOwnerData"><short>Функция возвращает данные о владельце файла</short>
<descr><p><b>procedure</b> GetFileOwnerData(<b>const</b> SearchDomain, FileName:<b>String</b>;<b>out</b> UserName, DomainName:<b>String</b>);</p><p>Процедура возвращает имя и домен пользователя операционной системы владельца указанного файла. </p><p><b>Входные параметры:</b>
</p><p>- SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).</p><p>- FileName - Полное имя файла.</p><p><b>Выходные параметры:</b>
</p><p>- UserName - Имя пльзователя.</p><p>- DomainName - Домен, в котором найден данный пользователь.</p><remark>В данный момент функция реализована только для windows.</remark>
</descr>
</element><element name="NormalizeDirectoryName"><short>Функция приводит все разделители в полном пути к файлу к виду принятом на текущей платформе</short>
<descr><p><b>function</b> NormalizeDirectoryName(<b>const</b> DirName:<b>string</b>):<b>string</b>;</p><p>Функция проверяет все разделители каталогов в указанном имени файла/каталога и, если нужно, меняет их на значение константы<b>DirectorySeparator</b>.</p>
</descr>
</element><element name="GetUserName"><short>Функция возвращяет имя текущего пользователя, зарегистрированного в операционной сиситеме на рабочем месте</short>
<descr><p><b>function</b> GetUserName: <b>string</b>;</p><p>Функция <b>GetUserName</b> возвращает имя оператора, зарегистрированного в системе</p>
</descr>
</element>
</module>
</package>