Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Composition Setup
 

Функция(метод)  Функция GrdStartup должна быть первой Guardant API функцией вызванной вызывается первой(ым) из приложения или DLL. Расширенная версия позволяет Дополнительно позволяет задать путь к файлу сетевых настроек клиентаgnсlient.ini.  

Синтаксис

Deck of Cards
id001
Card
defaulttrue
labelC
Code Block
languagecpp
int GRD_API GrdStartupEx(
	  DWORD dwRemoteMode,
	  const char* szNetworkClientIniPath,
	  DWORD dwFlagsdwRcsMode
);
Expand
titleПараметры функции

dwRemoteMode [in] 

Комбинация флагов, задающих режим поиска ключей. 

ЗначениеОписание

GrdFMR_Local1

Поиск локальных ключей.

GrdFMR_Remote2

Поиск сетевых ключей.

szNetworkClientIniPath [in] 

Путь к файлу gnclient.ini файлу сетевых настроек клиента, в зависимости от значения dwFlags.dwFlags dwRcsMode.

 

Info
titleВажно!

Путь (директория) к файлу сетевых настроек может указываться несколькими способами:

  • Путь заканчивается символом "\" — искать файл в заданной директории. Т.е. строка вида "C:\config\inifile\" означает что защищенное приложение будет искать файл "gnclient.ini" в директории "C:\config\inifile\" .
  • Путь без символа в конце строки "\" — задает директорию и имя файла сетевых настроек. Т.е. строка вида "C:\config\inifile" означает что защищенное приложение будет искать файл "inifile.ini" в директории "C:\config\" .
  • Только имя файла — задает имя файла сетевых настроек. Т.е. строка вида "inifile" означает что защищенное приложение будет искать файл "inifile.ini" в той же директории, где находится защищенное приложение.

dwRcsMode [in] 

Указывает как должен быть интерпретирован параметр szNetworkClientIniPath.

GrdRCS_UserDefined0x00000000

Путь задаётся пользователем. Параметр szNetworkClientIniPath должен содержать полный путь к файлу или директории, где будет расположен файл gnclient.iniсетевых настроек клиента.

Если параметр szNetworkClientIniPath равен NULL, то приложение будет искать файл gnclient.ini сетевых настроек клиента  в директории исполняемого файла.

GrdRCS_ProgramData

0x80000001

Путь задаётся пользователем относительно общей папки ProgramData (для Windows) или переменной окружения HOME (для Linux).  Параметр szNetworkClientIniPath должен

содержать относительный путь к файлу или директории, где расположен файл gnclient.iniбудет расположен файл сетевых настроек клиента.

GrdRCS_EnvVar0x80000002

Путь определяется через переменную окружения. Параметр szNetworkClientIniPath  должен содержать имя переменной окружения, которая содержит полный путь к файлу

или директории, где расположен файл gnclient.iniбудет расположен файл сетевых настроек клиента.

Expand
titleВозвращаемое значение функции

Набор ошибок Guardant API

Expand
titleОписание

Функция GrdStartupEх должна быть первой функцией Guardant API вызванной из приложения или DLL.

В зависимости от параметра dwRemoteMode инициализируются подсистемы API, предназначенные для работы с локальными и/или сетевыми ключами.

Дополнительно позволяет задать путь к файлу сетевых настроек клиента . Функция GrdStartupEx нужна для работы с сетевыми ключами,  когда файл сетевых настроек будет располагаться в директории отличной от расположения исполняемого файла. Параметр szNetworkClientIniPath  должен содержать полный путь к файлу или путь к директории заканчивающейся слешем. Во втором случае будет использовано имя файла по умолчанию (gnclient.ini). Если путь задан некорректно или нет прав доступа на запись в указанный файл или директорию, возвращается ошибка GrdE_UnableToCreateIniFile.

Если данная копия Guardant API уже была инициализирована, возвращается ошибка GrdE_AlreadyInitialized.

Cтандартный набор ошибок

 

Card
labelC#
Code Block
languagec#
public static GrdE GrdStartupEx(GrdFMR remoteMode, string networkClientIniPath)
public static GrdE GrdStartupEx(GrdFMR remoteMode, string networkClientIniPath, GrdRCS rcsMode )

Expand
titleПараметры метода

remoteMode [in] 

Тип: GrdFMR

Позволяет задать режим поиска ключей. 

networkClientIniPath [in]

Путь к файлу сетевых настроек клиента, в зависимости от значения rcsMode. Если параметр rcsMode не указан, необходимо задать полный путь по которому будет расположен данный файл.

rcsMode [in]

Тип: GrdRCS

Позволяет выбрать расположение файла сетевых настроек клиента.

Expand
titleВозвращаемое значение метода

Набор ошибок Guardant API

Expand
titleОписание

Метод GrdStartupEх - первый метод Guardant API, который должен быть вызван из приложения или DLL.

В зависимости от параметра remoteMode инициализируются подсистемы API, предназначенные для работы с локальными и/или сетевыми ключами.

Дополнительно метод позволяет задать путь к файлу сетевых настроек клиента. Метод GrdStartupEx нужен для работы с сетевыми ключами,  когда файл сетевых настроек будет располагаться в директории отличной от расположения исполняемого файла. Параметр szNetworkClientIniPath  должен содержать полный путь к файлу или путь к директории заканчивающейся слешем. Во втором случае будет использовано имя файла по умолчанию (gnclient.ini). Если путь задан некорректно или нет прав доступа на запись в указанный файл или директорию, возвращается ошибка GrdE.UnableToCreateIniFile.

Если данная копия Guardant API уже была инициализирована, возвращается ошибка GrdE.AlreadyInitialized .

Card
labelJava
Code Block
languagejava
 public static GrdE GrdStartupEx(GrdFMR remoteMode, String networkClientIniPath)
public static GrdE GrdStartupEx(GrdFMR remoteMode, String networkClientIniPath, GrdRCS rcsMode)
Expand
titleПараметры метода

remoteMode [in] 

Тип: GrdFMR

Позволяет задать режим поиска ключей. 

networkClientIniPath [in]

Путь к файлу сетевых настроек клиента, в зависимости от значения rcsMode. Если параметр rcsMode не указан, необходимо задать полный путь по которому будет расположен данный файл.

rcsMode [in]

Тип: GrdRCS

Позволяет выбрать расположение файла сетевых настроек клиента.

Expand
titleВозвращаемое значение метода

 

 

 

 

 

Набор ошибок Guardant API

Expand
titleОписание
Функция GrdStartupEх должна быть первой Guardant API функцией вызванной

Метод GrdStartupEх - первый метод Guardant API, который должен быть вызван из приложения или DLL.

В зависимости от параметра

dwRemoteMode

remoteMode инициализируются подсистемы API, предназначенные для работы с локальными и/или сетевыми ключами.

Расширенная версия позволяет

Дополнительно метод позволяет задать путь к файлу сетевых настроек клиента

gnclient

.

ini. Функция

Метод GrdStartupEx

нужна

нужен для работы с сетевыми ключами,  когда файл сетевых настроек

gnclient.ini должен

будет располагаться в директории отличной от расположения исполняемого файла. Параметр szNetworkClientIniPath  должен содержать полный путь к файлу или путь к директории заканчивающейся слешем. Во втором случае будет использовано имя файла по умолчанию (gnclient.ini). Если путь задан некорректно или нет прав доступа на запись в указанный файл или директорию, возвращается ошибка GrdE.UnableToCreateIniFile.

Если данная копия Guardant API уже была инициализирована, возвращается ошибка GrdE

_

.AlreadyInitialized .