Текущий раздел:

Описания RDS

Приложения

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

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

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

А.5.2.32. rdsIsValidVarName – проверка синтаксиса имени переменной

# Приложения

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

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

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

##### А.5.2.32. rdsIsValidVarName – проверка синтаксиса имени переменной

Функция rdsIsValidVarName проверяет переданное ей имя переменной на соответствие правилам языка C. Имя, соответствующее этим правилам, заведомо может использоваться в качестве имени переменной или блока в RDS.

      BOOL RDSCALL rdsIsValidVarNameA(
        RDSCSTR VarName,  // Имя переменной (UTF8)
        int MaxLength     // Max длина или 0
      );
      BOOL RDSCALL rdsIsValidVarNameW(
        RDSWCSTR VarName, // Имя переменной (UTF16)
        int MaxLength     // Max длина или 0
      );
      // Функция-псевдоним
      BOOL RDSCALL rdsIsValidVarName(
        RDSXCSTR VarName, // Имя переменной (кодировка по умолчанию)
        int MaxLength     // Max длина или 0
      );

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

RDS_BSI (для UTF8) или RDS_BWsI (для UTF16)

Параметры

VarName(RDSCSTR,RDSWCSTR,RDSXCSTR)
  Указатель на строку с проверяемым именем переменной.
MaxLength(int)
  Максимально допустимое число символов в имени переменной или 0, если проверять длину имени не нужно.

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

TRUE, если переданное в параметре VarName имя прошло проверку, FALSE в противном случае.

Примечания

Чтобы соответствовать правилам языка C, переданное в параметре VarName имя не должно содержать символов, отличных от латинских букв, цифр и знака подчеркивания, при этом оно не должно начинаться с цифры. Если в параметре MaxLength передано положительное число, имя переменной также не должно быть длиннее MaxLength символов.

Чаще всего функция rdsIsValidVarName используется в модулях автокомпиляции для проверки допустимости вводимых пользователем имен переменных.