Приложения

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

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

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

А.5.2.29. rdsGetSystemInt – получить целый системный параметр

Функция rdsGetSystemInt возвращает целое значение, являющееся либо общесистемным параметром, либо параметром, характеризующим состояние RDS в данный момент. Эти параметры разнородны, их объединяет только то, что все они целые и относятся к RDS и схеме в целом, а не к отдельному объекту схемы.

  int RDSCALL rdsGetSystemInt(
    int ValueId    // Запрашиваемый параметр
  );

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

RDS_II

Параметр

ValueId (int)

Идентификатор запрашиваемого параметра. Может принимать одно из следующих значений:

RDS_GSIBAKFILESCOUNT	Число файлов резервных копий, создаваемых при сохранении схемы (задается в настройках RDS).
RDS_GSICMDPARAMCOUNT	Число параметров командной строки, не обработанных RDS (аналог функции rdsGetCmdParamCount).
RDS_GSIDEFAULTPORT	Номер порта по умолчанию для сетевых соединений (задается в настройках RDS).
RDS_GSIINSTSTRUCTCOUNT	Общее число структур (структурных типов переменных блока), зарегистрированных в RDS.
RDS_GSIMODIFIED	Признак наличия изменений в схеме (функция возвращает 1, если схема была изменена с момента последнего сохранения, и 0, если изменений не было). Флаг наличия изменений можно установить программно вызовом функции rdsSetModifiedFlag.
RDS_GSISAVELOADACTION	Действие, вызвавшее загрузку или запись параметров блока (одна из констант RDS_LS_*, см. ниже).
RDS_GSISTOPPING	Признак того, что расчет в данный момент останавливается (возвращается 1, если была запрошена остановка расчета, но поток расчета еще не успел остановиться, и 0, если расчет работает в нормальном режиме или уже остановлен).
RDS_GSITICKPARITY	Четность текущего такта расчета (возврат: 0 – четный такт, 1 – нечетный). Этот параметр автоматически инвертируется каждый такт расчета и позволяет выполнять какие-либо действия через один такт.
RDS_GSIUNDOSIZE	Число шагов отмены действий пользователя при редактировании схемы (0 – отмена отключена). Задается в настройках RDS.
RDS_GSILEGACYCODEPAGE	Кодовая страница, используемая при обнаружении в загружаемой схеме символов национальных алфавитов для их перекодировки в UTF8 (это возможно при загрузке схемы, сохраненной старой версией RDS). Задается в настройках RDS.
RDS_GSIWINFONTQUALITY	Способ сглаживания шрифтов, задаваемый скрытым параметром в файле «Rds.ini» (секция «[MainWindow]», параметр «GlobalFontQuality=целое_число>»). Этот параметр может применяться для принудительного отключения сглаживания в случае возникновения каких-либо проблем или по эстетическим соображениям. Возвращается одна из констант RDS_FQ_*, см. ниже).

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

Значение запрошенного параметра. Для некоторых параметров это просто целое числовое значение, для некоторых – 1 или 0 в зависимости от состояния RDS.

Возвращаемые значения для RDS_GSISAVELOADACTION

Вызов rdsGetSystemInt(RDS_GSISAVELOADACTION) возвращает одну из следующих констант, указывающих на причину загрузки или записи параметров блока, происходящей в данный момент:

Возвращаемые значения для RDS_GSIWINFONTQUALITY

Вызов rdsGetSystemInt(RDS_GSIWINFONTQUALITY) возвращает одну из следующих констант, указывающих на заданный в «Rds.ini» способ сглаживания шрифтов:

Пример

Пример использования rdsGetSystemInt(RDS_GSISAVELOADACTION) для выяснения причины сохранения параметров блока приведен в §2.10.4 руководства программиста.

См. также

rdsGetSystemPath.