From 1101949cce6351b1260ed80bf25c2ed5db94f0b4 Mon Sep 17 00:00:00 2001 From: alexs75 Date: Wed, 20 Jul 2016 05:53:15 +0000 Subject: [PATCH] RxFPC: documentation git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@5008 8e941d3f-bd1b-0410-a28a-d453659cc2b4 --- components/rx/trunk/docs/rxFileUtils.xml | 263 ----------------------- components/rx/trunk/docs/rxfileutils.xml | 11 + 2 files changed, 11 insertions(+), 263 deletions(-) delete mode 100644 components/rx/trunk/docs/rxFileUtils.xml diff --git a/components/rx/trunk/docs/rxFileUtils.xml b/components/rx/trunk/docs/rxFileUtils.xml deleted file mode 100644 index 117ac15bb..000000000 --- a/components/rx/trunk/docs/rxFileUtils.xml +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - - Возвращает имя владельца файла - -

function GetFileOwnerUser(const SearchDomain, FileName:String):String; -

-

Функция возвращает имя пользователя операционной системы владельца указанного файла.

-

- Входные параметры: -

-

SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).

-

FileName - Полное имя файла.

- В данный момент функция реализована только для windows. -
- - - -
- - Возвращает данные владельца файла - -

- procedure GetFileOwnerData( - - - - - - - - - - - - - - - - - - - - - - - - - - - const SearchDomain, FileName: - - - - - - - - - - - - - - - - - - - - - - - - - - - String; - - - - - - - - - - - - - - - - - - - - - - - - - - - out UserName, DomainName: - - - - - - - - - - - - - - - - - - - - - - - - - - - String); -

-

Процедура возвращает имя и домен пользователя операционной системы владельца указанного файла.

-

- Входные параметры: -

-

- SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).

-

- FileName - Полное имя файла.

-

- Выходные параметры: -

-

- UserName - Имя пльзователя.

-

- DomainName - Домен, в котором найден данный пользователь.

- В данный момент функция реализована только для windows. -
- - - -
- - Функция приводит к принятому в данной ОС виду все разделители каталогов. - -

- function NormalizeDirectoryName( - - - - - - - - - - - - - - - - - - - - - const DirName: - - - - - - - - - - - - - - - - - - - - - string): - - - - - - - - - - - - - - - - - - - - - string;

-

Функция проверяет все разделители каталогов в указанном имени файла/каталога и, если нужно, меняет их на значение константыDirectorySeparator.

-
-
- Содержит дополнительные утилиты работы с файлами и ОС - - Функция GetUserName возвращает имя оператора, залогиненго в системе - -

- function GetUserName: - - - - - - - - - - - - - - - - - - - - - - - - - - string;

-

Функция GetUserName возвращает имя оператора, залогиненго в системе

-
-
-
- -
-
diff --git a/components/rx/trunk/docs/rxfileutils.xml b/components/rx/trunk/docs/rxfileutils.xml index 92fe9f2d1..79899be15 100644 --- a/components/rx/trunk/docs/rxfileutils.xml +++ b/components/rx/trunk/docs/rxfileutils.xml @@ -5,9 +5,20 @@ Функция приводит имя файла к правильному виду в зависимости от платформы

Данная функция проверяет все символы в имени файла и заменяет запрещённые символы на указанный AReplaceChar.

По умолчанию вместо AReplaceChar подставляется символ "_" (подчёркивание)

Функция возвращает имя пользователя - владельца файла +

function GetFileOwnerUser(const SearchDomain, FileName:String):String;

Функция возвращает имя пользователя операционной системы владельца указанного файла.

Входные параметры: +

SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).

FileName - Полное имя файла.

В данный момент функция реализована только для windows. +
Функция возвращает данные о владельце файла +

procedure GetFileOwnerData(const SearchDomain, FileName:String;out UserName, DomainName:String);

Процедура возвращает имя и домен пользователя операционной системы владельца указанного файла.

Входные параметры: +

- SearchDomain - Домен, в котором будет производится поиск оператора (пустой для текущего домена оператора).

- FileName - Полное имя файла.

Выходные параметры: +

- UserName - Имя пльзователя.

- DomainName - Домен, в котором найден данный пользователь.

В данный момент функция реализована только для windows. +
Функция приводит все разделители в полном пути к файлу к виду принятом на текущей платформе +

function NormalizeDirectoryName(const DirName:string):string;

Функция проверяет все разделители каталогов в указанном имени файла/каталога и, если нужно, меняет их на значение константыDirectorySeparator.

+
Функция возвращяет имя текущего пользователя, зарегистрированного в операционной сиситеме на рабочем месте +

function GetUserName: string;

Функция GetUserName возвращает имя оператора, зарегистрированного в системе

+