Приложения

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

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

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

А.5.2.43. rdsSetEnvironmentVariable – установка значения переменной окружения

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

  RDSSTR RDSCALL rdsSetEnvironmentVariableA( // UTF8
    RDSCSTR Name,   // Имя переменной системного окружения (UTF8)
    RDSCSTR Value,  // Устанавливаемое значение переменной (UTF8)
    BOOL ReturnOld  // Вернуть старое значение, если переменная существовала
  );
  RDSWSTR RDSCALL rdsSetEnvironmentVariableW( // UTF16
    RDSWCSTR Name,  // Имя переменной системного окружения (UTF16)
    RDSWCSTR Value, // Устанавливаемое значение переменной (UTF16)
    BOOL ReturnOld  // Вернуть старое значение, если переменная существовала
  );
  // Функция-псевдоним
  RDSXSTR RDSCALL rdsSetEnvironmentVariable( // Кодировка по умолчанию
    RDSXCSTR Name,  // Имя переменной системного окружения (кодировка по умолчанию)
    RDSXCSTR Value, // Устанавливаемое значение переменной (кодировка по умолчанию)
    BOOL ReturnOld  // Вернуть старое значение, если переменная существовала
  );

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

RDS_SSSB (для UTF8) или RDS_WsWsWsB (для UTF16)

Параметры

Name (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с именем переменной системного окружения.
Value (RDSCSTR, RDSWCSTR, RDSXCSTR): Указатель на строку с новым значением переменной.
ReturnOld (BOOL): TRUE – вернуть указатель на созданную в динамической памяти строку, содержащую прежнее значение переменной (если такой переменной не существовало, возвращается NULL). FALSE – не формировать строку и вернуть NULL в любом случае.

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

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

Примечания

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

Пример

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

См. также

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