Приложения

Приложение А. Функции, константы и структуры RDS

А.5. Сервисные функции и макросы RDS

А.5.2. Управление работой RDS и функции общего назначения

А.5.2.26. rdsGetEnvironmentVariable – получение значения переменной окружения

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

  RDSSTR RDSCALL rdsGetEnvironmentVariableA( // UTF8
    RDSCSTR Name  // Имя переменной системного окружения (UTF8)
  );
  RDSWSTR RDSCALL rdsGetEnvironmentVariableW( // UTF16
    RDSWCSTR Name // Имя переменной системного окружения (UTF16)
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsGetEnvironmentVariable( // Кодировка по умолчанию
    RDSXCSTR Name // Имя переменной системного окружения (кодировка по умолчанию)
  );

Тип указателя на эту функцию

RDS_SS (для UTF8) или RDS_WsWs (для UTF16)

Параметр

Name (RDSCSTR, RDSWCSTR, RDSXCSTR)

Указатель на строку с именем переменной системного окружения.

Возвращаемое значение

Указатель на созданную в динамической памяти строку, содержащую значение переменной. Если переменная с указанным именем не существует, возвращается NULL.

Примечания

Динамическая строка, созданная функцией rdsGetEnvironmentVariable, должна быть обязательно освобождена вызовом rdsFree.

Пример

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

См. также

Сервисные функции со строковыми параметрами и результатом, rdsSetEnvironmentVariable, rdsFree.