Приложение 1. Библиотека функций NetWare C Interface for DOS

• 9.1. Разные функции
• 9.2. Каналы, подключение к файл-серверу и отключение от файл-сервера
• 9.3. Работа с томами файл-сервера
• 9.4. Отображение дисков рабочей станции на сетевые каталоги
• 9.5. Просмотр содержимого каталогов
• 9.6. Создание, переименование и удаление каталога
• 9.7. Работа с файлами
• 9.8. Синхронизация процессов
• 9.9. Работа с базой объектов Bindery
• 9.10. Передача и прием сообщений
• 9.11. Управление файл-сервером
• 9.12. Работа с протоколом IPX

9.1. Разные функции

Проверка сетевой оболочки

int GetShellVersionInformation(BYTE *MajorVersion,
                BYTE *MinorVersion, BYTE *RevisionLevel);

Функция возвращает 0xFF при нормальном завершении или 0 при ошибке.

Параметры:

Обмен байтов в 16-битовом слове

int IntSwap(int UnswappedInteger);

Функция меняет местами байты в 16-битовом слове, которое передается ей в качестве параметра, возвращая полученное значение.

Параметры:

Обмен байтов в 32-битовом слове

long LongSwap(long UnswappedLong);

Функция меняет местами байты в 32-битовом слове, которое передается ей в качестве параметра, возвращая полученное значение.

Параметры:

9.2. Каналы, подключение к файл-серверу и отключение от 9.3. файл-сервера

Подключение к файл-серверу

int AttachToFileServer(char *ServerName, WORD *ConnectionID);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Отключение от файл-сервера

void DetachFromFileServer(WORD ConnectionID);

Параметры:

Получить номер канала первичного сервера

WORD GetPrimaryConnectionID(void);

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

Получить номер канала текущего сервера

WORD GetDefaultConnectionID(void);

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

Установить предпочтительный сервер

void SetPreferredConnectionID(BYTE ConnectionID);

Параметры:

Подключение к файл-серверу

int LoginToFileServer(char *ObjectName, WORD ObjectType,
                        char *ObjectPassword);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Отключение от всех файл-серверов

void Logout(void);

Отключение от одного файл-сервера

void LogoutFromFileServer(WORD ConnectionID);

Параметры:

9.3. Работа с томами файл-сервера

Получить имя тома по номеру тома

int GetVolumeName(int VolumeNumber, char*VolumeName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получить номер тома по имени тома

int GetVolumeNamber(char*VolumeName, int *VolumeNumber);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получить информацию о томе

int GetVolumeInfoWithNumber(BYTE VolumeNumber, char *VolumeName,
        WORD *TotalBlocks, WORD *SectorsPerBlock,
        WORD *AvailableBlocks, WORD *TotalDirectorySlots,
        WORD *AvailableDirectorySlots, WORD *Removable);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.4. Отображение дисков рабочей станции на сетевые каталоги

Создание нового элемента в таблице индексов каталога

int AllocPermanentDirectoryHandle(BYTE DirectoryHandle,
    char *DirectoryPath, char DriveLetter,
    BYTE *NewDirectoryHandle, BYTE *EffectiveRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление элемента из таблицы индексов каталога

int DeallocateDirectoryHandle(BYTE DirectoryHandle);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получить индекс каталога по номеру диска

int GetDirectoryHandle(char Drive);

Функция возвращает индекс каталога или 0 при ошибке.

Параметры:

Создание временного элемента в таблице индексов каталога

int AllocTemporaryDirectoryHandle(BYTE DirectoryHandle,
    char *DirectoryPath, char DriveLetter,
    BYTE *NewDirectoryHandle, BYTE *EffectiveRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.5. Просмотр содержимого каталогов

Поиск подкаталогов в сетевых каталогах

int ScanDirectoryInformation(BYTE DirectoryHandle,
        char *SearchDirectoryPath, int *SequenceNumber,
        char *DirectoryName, BYTE *CreationDateAndTime,
        long *OwnerObjectID, BYTE *MaximumRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.6. Создание, переименование и удаление каталога

Создание каталога

int CreateDirectory(BYTE DirectoryHandle,
     char* DirectoryPath, BYTE MaximumGightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Переименование каталога

int RenameDirectory(BYTE DirectoryHandle,
     char* DirectoryPath, char *NewDirectoryName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление каталога

int DeleteDirectory(BYTE DirectoryHandle, char* DirectoryPath);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получение маски прав доступа каталога

int GetEffectiveDirectoryRights(BYTE DirectoryHandle,
    char *DirectoryPath, BYTE *EffectiveRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Изменение атрибутов каталога

int SetDirectoryInformation(BYTE DirectoryHandle,
     char *DirectoryPath, BYTE *NewCreationDateAndTime,
     long NewOwnerObjectID, BYTE MaximumRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Изменение маски доступа каталога

int ModifyMaximumRightsMask(BYTE DirectoryHandle,
       char *DirectoryPath, BYTE RevokeRightsMask,
       BYTE GrantRightsMask);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.7. Работа с файлами

Поиск файлов

int _ScanFileInformation(BYTE DirectoryHandle, char *FilePath,
   BYTE SearchAttributes, int *SequenceNumber, char *FileName,
   BYTE *FileAttributes, BYTE *ExtendedFileAttributes,
   long *FileSize, char *CreationDate, char *LastAccessDate,
   char *LastUpdateDateAndTime, char *LastArchiveDateAndTime,
   long *FileOwnerID);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Изменение атрибутов файла

int SetFileInformation(BYTE DirectoryHandle, char *FilePath,
   BYTE SearchAttributes, BYTE FileAttributes,
   BYTE ExtendedFileAttributes, char *CreationDate,
   char *LastAccessDate, char *LastUpdateDateAndTime,
   char *LastArchiveDateAndTime, long *FileOwnerID);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получение байта расширенных атрибутов

int GetExtendedFileAttributes(char *FilePath,
                BYTE *ExtendedFileAttributes);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Изменение байта расширенных атрибутов

int SetExtendedFileAttributes(char *FilePath,
                BYTE *NewExtendedFileattributes);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Копирование файлов

int FileServerFileCopy(int FromHandle, int ToHandle,
        long SourceFileOffset, long DestinationFileOffset,
        long NumberOfBytesToCopy, long *BytesCopied);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление файлов

int EraseFiles(BYTE DirectoryHandle, char *FilePath, 
                BYTE SearchAttributes);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.8. Синхронизация процессов

Добавление файла в группу

int LogFile(char *FileName, BYTE LockDirective,WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление файла из группы

int ClearFile(char *FileName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление группы и разблокирование всех файлов

void ClearFileSet(void);

Блокирование группы файлов

int LockFileSet(WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование отдельных файлов

int ReleaseFile(char *FileName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование всех файлов

void  ReleaseFileSet(void);

Добавление физической записи в группу

int LogPhysicalRecord(int FileHandle, long RecordStartOffset,
    long RecordLength, BYTE LockDirective,WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление записи из группы

int ClearPhysicalRecord(int FileHandle,
    long RecordStartOffset, long RecordLength);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование группы записей и удаление группы

void ClearPhysicalRecordSet(void);

Блокирование группы физических записей

int LockPhysicalRecordSet(BYTE LockDirective, WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование отдельных записей

int ReleasePhysicalRecord(int FileHandle,
    long RecordStartOffset, long RecordLength);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование всех физических записей

void  ReleasePhysicalRecordSet(void);

Добавление логической записи в группу

int LogLogicalRecord(char LogicalRecordName,
    BYTE LockDirective,WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Удаление логической записи из группы

int ClearLogicalRecord(char LogicalRecordName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование всех логических записей и удаление группы

void ClearLogicalRecordSet(void);

Блокирование группы логических записей

int LockLogicalRecordSet(WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование отдельных логических записей

int ReleaseLogicalRecord(char LogicalRecordName);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Разблокирование всех логических записей

void  ReleaseLogicalRecordSet(void);

Открытие семафора

int OpenSemaphore(char *SemaphoreName, int InitialValue,
      long *SemaphoreHandle, WORD *OpenCount);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Закрытие семафора

int CloseSemaphore(long SemaphoreHandle);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Определение состояния семафора

int ExamineSemaphore(long SemaphoreHandle,
      int *SemaphoreValue, WORD *OpenCount);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Уменьшение значения семафора

int WaitOnSemaphore(long SemaphoreHandle, WORD Timeout);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Увеличение значения семафора

int SignalSemaphore(long SemaphoreHandle);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.9. Работа с базой объектов Bindery

Определение собственного уровня доступа

int GetBinderyAccessLevel(BYTE *SecurityAccessLevel, long *ObjectID);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получение имени и типа объекта по его идентификатору

 int GetBinderyObjectName(long ObjectID,
     char *ObjectName, WORD *ObjectType);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получение идентификатора объекта по его имени и типу

int GetBinderyObjectID(char *ObjectName,WORD ObjectType, long *ObjectID);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Поиск объектов в базе Bindery

int ScanBinderyObject(char *SearchObjectName, WORD SearchObjectType,
  long *ObjectID, char *ObjectName, WORD *ObjectType, 
  char *ObjectHasProperties, char *ObjectFlag, char *ObjectSecurity);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Поиск записей для объектов

int ScanProperty(char *ObjectName, WORD ObjectType, 
   char *SearchPropertyName, long *SequenceNumber,
   char *PropertyName, char *PropertyFlag, char *PropertySecurity,
   char *PropertyHasValue, char *MoreProperties);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.10. Передача и прием сообщений

Определение режима приема сообщений

BYTE GetBroadcastMode(void);

Функция возвращает значение в диапазона от 0 до 3, соответствующее текущему режиму приема сообщений.

Установка режима приема сообщений

void SetBroadcastMode(BYTE BroadcastMode);

Параметры:

Передача сообщений пользователям

int SendBroadcastMessage(char *Message, WORD *ConnectionList,
       BYTE *ResultList, WORD ConnectionCount);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Запись сообщения в журнал

int LogNetworkMessage(char *Message);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Прием сообщений

int GetBroadcastMessage(char *MessageBuffer);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.11. Управление файл-сервером

Определение даты и времени

void GetFileServerDateAndTime(BYTE *DateAndTime);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Получение строк описания файл-сервера

int GetFileServerDescriptionStrings(char *CompanyName,
        char *Revision, char *RevisionDate, char *CopyrightNotice);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Определение имени файл-сервера

void GetFileServerName(WORD ConnectionID, char *FileServerName);

Параметры:

Получение информации о файл-сервере

int GetServerInformation(int StructSize, FILE_SERV_INFO *ServerInfo);

Параметры:

Формат структуры FILE_SERV_INFO:

typedef struct  {
         char    serverName[48];
         BYTE    netwareVersion;
         BYTE    netwareSubVersion;
         WORD    maxConnectionsSupported;
         WORD    connectionsInUse;
         WORD    maxVolumesSupported;
         BYTE    revisionLevel;
         BYTE    SFTLevel;
         BYTE    TTSLevel;
         WORD    peakConnectionsUsed;
         BYTE    accountingVersion;
         BYTE    VAPversion;
         BYTE    queingVersion;
         BYTE    printServerVersion;
         BYTE    virtualConsoleVersion;
         BYTE    securityRestrictionLevel;
         BYTE    internetBridgeSupport;
 } FILE_SERV_INFO;

Описание полей структуры FILE_SERV_INFO:

Определение возможности подключения к файл-серверу

int GetFileServerLoginStatus(int *LoginEnabledFlag);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Установка даты и времени

int SetFileServerDateAndTime(WORD Year, WORD Month,
                WORD Day, WORD Hour, WORD Minute, WORD Second);

Параметры:

Запрет подключения к файл-серверу

int DisableFileServerLogin(void);

Функция возвращает 0 при успешном завершении или код ошибки.

Разрешение подключения к файл-серверу

int EnableFileServerLogin(void);

Функция возвращает 0 при успешном завершении или код ошибки.

Останов файл-сервера

int DownFileServer(int ForceFlag);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

9.12. Работа с протоколом IPX

В этом разделе мы приведем описание тех функций, предназначенных для работы с протоколом IPX, которые были использованы в нашей книге. Полное описание дано в документации, поставляющейся с библиотекой Novell NetWare C Interface.

Инициализация драйвера IPX

int IPXInitialize(void) ;

Функция возвращает 0 при успешном завершении или код ошибки.

Открытие сокета

int IPXOpenSocket(char *SocketNumber, char SocketType) ;

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Закрытие сокета

int IPXCloseSocket(char *SocketNumber);

Функция возвращает 0 при успешном завершении или код ошибки.

Параметры:

Прием IPX-пакета

void IPXListenForPacket(ECB *EventControlBlock);

Параметры:

Передача пакета

void IPXSendPacket(ECB *EventControlBlock);

Параметры:

Отмена блока ECB

void IPXCancelEvent(ECB *EventControlBlock);

Параметры:

Определение собственного сетевого адреса

void IPXGetInternetworkAddress(IPXAddress *NetworkAddress) ;

Параметры:

Типы данных

Сетевой адрес

typedef struct IPXAddress {
    BYTE    network[4];
    BYTE    node[6];
    BYTE    socket[2];
} IPXAddress;

Заголовок пакета IPX

typedef struct IPXHeader {
    WORD        checkSum;
    WORD        length;
    BYTE        transportControl;
    BYTE        packetType;
    IPXAddress  destination;
    IPXAddress  source;
} IPXHeader;

Дальние указатели на данные и функции

#define FARDATAPTR(type,var) type far *var
#define FARCODEPTR(type,var) type (far *var)()

Дескриптор фрагмента

typedef struct ECBFragment {
    FARDATAPTR(void,address);
    WORD    size;
} ECBFragment;

Блок ECB

typedef struct ECB {
    FARDATAPTR(void, linkAddress);
    FARCODEPTR(void, ESRAddress);
    BYTE        inUseFlag;
    BYTE        completionCode;
    WORD        socketNumber;
    BYTE        IPXWorkspace[4];
    BYTE        driverWorkspace[12];
    BYTE        immediateAddress[6];
    WORD        fragmentCount;
    ECBFragment fragmentDescriptor[2];
} ECB;