跳到主要内容

字符串+字符

共 18 个 API(18 个可执行)

本页收录标准函数分类“字符串+字符”下的完整 API 合同。

提取字符​

CHAR_AT 可执行

标准函数 CHAR_AT:从字符串指定零基索引位置提取单个字符。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING CHAR_AT(STRING text, INT index)

参数​

textSTRING
  • 输入
  • 必填
源字符串。
indexINT
  • 输入
  • 必填
  • 约束 越界索引返回空字符串。
零基字符索引。

返回值​

returnSTRING
单个字符的字符串;越界返回空串。

行为说明​

  • 零基索引,越界时返回空字符串而非抛异常。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

提取字符串的第一个字符。
STRING ch = CHAR_AT(tag, 0);

相关 API​

暂无已核实关系。

比较字符串​

STR_CMP 可执行

标准函数 STR_CMP:按内容比较两个字符串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

INT STR_CMP(STRING left, STRING right)

参数​

leftSTRING
  • 输入
  • 必填
第一个字符串。
rightSTRING
  • 输入
  • 必填
第二个字符串。

返回值​

returnINT
小于、等于、大于分别对应负值、0、正值。

行为说明​

  • 按字符串内容比较,不是按内部标识。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

比较实际值和期望值。
INT compare = STR_CMP(actual, expected);

相关 API​

暂无已核实关系。

拼接字符串​

STR_CONCAT 可执行

标准函数 STR_CONCAT:按顺序拼接两个字符串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_CONCAT(STRING left, STRING right)

参数​

leftSTRING
  • 输入
  • 必填
前半字符串。
rightSTRING
  • 输入
  • 必填
后半字符串。

返回值​

returnSTRING
left 后接 right 的新字符串。

行为说明​

  • 按参数顺序拼接。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

拼接标签。
STRING label = STR_CONCAT(prefix, suffix);

相关 API​

暂无已核实关系。

删除字符串范围​

STR_DELETE 可执行

标准函数 STR_DELETE:从指定位置删除指定长度的字符。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_DELETE(STRING value, INT position, INT length)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。
positionINT
  • 输入
  • 必填
  • 约束 零基位置;按 0..源字符串长度钳制。
删除起始位置。
lengthINT
  • 输入
  • 必填
  • 约束 长度按 0..剩余字符数钳制。
删除字符数。

返回值​

returnSTRING
删除指定范围后的新字符串。

行为说明​

  • 删除长度超过剩余字符数时钳制到字符串末尾。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

删除前五个字符。
STRING result = STR_DELETE(message, 0, 5);

相关 API​

暂无已核实关系。

查找子串​

STR_FIND 可执行

标准函数 STR_FIND:在源字符串中查找子串的首次出现位置。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

INT STR_FIND(STRING text, STRING pattern)

参数​

textSTRING
  • 输入
  • 必填
源字符串。
patternSTRING
  • 输入
  • 必填
待查找的子串。

返回值​

returnINT
零基首次出现位置;未找到返回 -1。

行为说明​

  • 返回子串首次出现的零基索引,未找到返回 -1。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

查找"error"在消息中的位置。
INT pos = STR_FIND(message, "error");

相关 API​

暂无已核实关系。

单参数格式化​

STR_FORMAT 可执行

标准函数 STR_FORMAT:PLC 安全版格式化:以一个字符串参数替换模板中的全部 {0}。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_FORMAT(STRING format, STRING argument)

参数​

formatSTRING
  • 输入
  • 必填
  • 约束 当前仅支持 {0} 单参数占位。
可含 {0} 的模板字符串。
argumentSTRING
  • 输入
  • 必填
替换 {0} 的字符串。

返回值​

returnSTRING
格式化后的字符串。

行为说明​

  • 替换模板中的全部 {0}。
  • 模板不含 {0} 时原样返回。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

把一个字符串参数写入温度模板。
STRING text = STR_FORMAT("Temp={0}C", valueText);

相关 API​

暂无已核实关系。

插入字符串​

STR_INSERT 可执行

标准函数 STR_INSERT:在指定位置插入子串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_INSERT(STRING value, INT position, STRING inserted)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。
positionINT
  • 输入
  • 必填
  • 约束 零基位置;按 0..源字符串长度钳制。
插入位置。
insertedSTRING
  • 输入
  • 必填
待插入子串。

返回值​

returnSTRING
插入后的新字符串。

行为说明​

  • position 超过源字符串长度时钳制到末尾。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

在位置五插入分隔符。
STRING result = STR_INSERT(plain, 5, separator);

相关 API​

暂无已核实关系。

取左侧子串​

STR_LEFT 可执行

标准函数 STR_LEFT:从字符串左侧取得指定长度的子串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_LEFT(STRING value, INT length)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。
lengthINT
  • 输入
  • 必填
  • 约束 长度按 0..源字符串长度钳制。
从左侧取得的字符数。

返回值​

returnSTRING
源字符串左侧子串。

行为说明​

  • 从左侧截取指定长度。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

取得序列号前四个字符。
STRING code = STR_LEFT(serial, 4);

相关 API​

暂无已核实关系。

字符串长度​

STR_LEN 可执行

标准函数 STR_LEN:返回字符串的字符数。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

INT STR_LEN(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
输入字符串。

返回值​

returnINT
字符串字符数。

行为说明​

  • 返回字符串字符数。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

读取消息长度。
INT length = STR_LEN(message);

相关 API​

暂无已核实关系。

转为小写​

STR_LOWER 可执行

标准函数 STR_LOWER:把字符串转换为小写形式。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_LOWER(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
小写字符串。

行为说明​

  • 把字符串转为小写。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

规范化键名为小写。
STRING key = STR_LOWER(input);

相关 API​

暂无已核实关系。

取中间子串​

STR_MID 可执行

标准函数 STR_MID:从指定位置取得指定长度的子串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_MID(STRING value, INT position, INT length)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。
positionINT
  • 输入
  • 必填
  • 约束 零基位置;按 0..源字符串长度钳制。
起始位置。
lengthINT
  • 输入
  • 必填
  • 约束 长度按 0..剩余字符数钳制。
取得的字符数。

返回值​

returnSTRING
指定范围的子串。

行为说明​

  • 从指定位置截取指定长度。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

提取消息片段。
STRING segment = STR_MID(message, 2, 4);

相关 API​

暂无已核实关系。

替换字符串​

STR_REPLACE 可执行

标准函数 STR_REPLACE:把源字符串中的全部 oldValue 替换为 newValue。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_REPLACE(STRING value, STRING oldValue, STRING newValue)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。
oldValueSTRING
  • 输入
  • 必填
被替换子串。
newValueSTRING
  • 输入
  • 必填
替换子串。

返回值​

returnSTRING
完成替换后的新字符串。

行为说明​

  • 替换全部匹配项。
  • oldValue 为空字符串时原样返回 value。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

替换消息中的全部标记。
STRING result = STR_REPLACE(message, oldToken, newToken);

相关 API​

暂无已核实关系。

取右侧子串​

STR_RIGHT 可执行

标准函数 STR_RIGHT:从字符串右侧取得指定长度的子串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_RIGHT(STRING text, INT count)

参数​

textSTRING
  • 输入
  • 必填
源字符串。
countINT
  • 输入
  • 必填
  • 约束 长度按 0..源字符串长度钳制。
要提取的字符数。

返回值​

returnSTRING
右侧子串。

行为说明​

  • 从字符串右侧提取指定长度的字符。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

取字符串最后 3 个字符。
STRING suffix = STR_RIGHT(tag, 3);

相关 API​

暂无已核实关系。

复制字符串​

STR_CPY 可执行

标准函数 STR_CPY:拷贝字符串,返回内容相同的新字符串。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_CPY(STRING source)

参数​

sourceSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
内容相同的新字符串。

行为说明​

  • 用于把一个字符串值赋给另一字符串变量(拷贝语义)。
  • 拷贝字符串内容,返回新字符串。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

复制字符串。
STRING copy = STR_CPY(original);

相关 API​

暂无已核实关系。

去除两端空白​

STR_TRIM 可执行

标准函数 STR_TRIM:去除字符串两端空白。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_TRIM(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
去除两端空白后的字符串。

行为说明​

  • 只去除两端空白,不改变中间字符。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

清理输入两端空白。
STRING normalized = STR_TRIM(input);

相关 API​

暂无已核实关系。

去除结尾空白​

STR_TRIM_END 可执行

标准函数 STR_TRIM_END:去除字符串结尾空白。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_TRIM_END(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
去除结尾空白后的字符串。

行为说明​

  • 保留开头空白。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

清理结尾空白。
STRING result = STR_TRIM_END(input);

相关 API​

暂无已核实关系。

去除开头空白​

STR_TRIM_START 可执行

标准函数 STR_TRIM_START:去除字符串开头空白。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_TRIM_START(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
去除开头空白后的字符串。

行为说明​

  • 保留结尾空白。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

清理开头空白。
STRING result = STR_TRIM_START(input);

相关 API​

暂无已核实关系。

转为大写​

STR_UPPER 可执行

标准函数 STR_UPPER:把字符串转换为大写形式。

可执行
  1. 声明层

    已声明
  2. 验证层

    已验证
  3. 执行层

    可执行

签名​

STRING STR_UPPER(STRING value)

参数​

valueSTRING
  • 输入
  • 必填
源字符串。

返回值​

returnSTRING
大写字符串。

行为说明​

  • 把字符串转为大写。

错误与限制​

此外,本 API 还可能触发以下共享错误码(详见共享错误码):COMPILE_ARGUMENT_ERROR、STRING_ARGUMENT_REQUIRED。

示例​

规范化代码为大写。
STRING code = STR_UPPER(input);

相关 API​

暂无已核实关系。


共享错误码​

以下错误码在本分类的多个 API 条目中重复出现,统一在此说明以避免冗余。各条目的"错误与限制"小节仅列出该 API 专属的错误码。

错误码前缀对照​

前缀含义示例
COMPILE_编译参数:SCL 参数类型/范围/枚举校验COMPILE_ARGUMENT_ERROR
STRING_字符串参数STRING_ARGUMENT_REQUIRED

COMPILE_ARGUMENT_ERROR​

COMPILE_ 编译参数:SCL 参数类型/范围/枚举校验

出现在 18 个 API 条目中。

  • 缺少必需实参或参数类型不匹配时编译失败。

STRING_ARGUMENT_REQUIRED​

STRING_ 字符串参数

出现在 18 个 API 条目中。

  • 字符串参数不是 STRING/WSTRING 字面量、变量或受支持字符串值表达式时编译失败。