第十一章 ObjectScript 系统宏（二）

宏引用

`FormatText(text, arg1, arg2, ...)`

FormatText 宏接受输入文本消息 (text)，其中可能包含 %1、%2 等形式的参数。然后，FormatText 将这些参数替换为文本参数后面的宏参数（arg1、arg2 等）。按照这些附加参数的顺序。然后它返回结果字符串。该宏需要 %occMessages.inc。

`FormatTextHTML(text, arg1, arg2, ...)`

FormatTextHTML 宏接受输入文本消息 (text)，其中可能包含 %1、%2 等形式的参数。然后，FormatTextHTML 将这些参数替换为文本参数后面的宏参数（arg1、arg2 等）。按照这些附加参数的顺序；然后宏应用 HTML 转义。然后它返回结果字符串。该宏需要 %occMessages.inc。

`FormatTextJS(text, arg1, arg2, ...)`

FormatTextJS 宏接受输入文本消息 (text)，其中可能包含 %1、%2 等形式的参数。然后，FormatTextJS 将这些参数替换为文本参数后面的宏参数（arg1、arg2 等）。按照这些附加参数的顺序；然后宏应用 JavaScript 转义。然后它返回结果字符串。该宏需要 %occMessages.inc。

`GETERRORCODE(sc)`

GETERRORCODE 宏从提供的 %Status 代码 (sc) 返回错误代码值。该宏需要 %occStatus.inc。

`GETERRORMESSAGE(sc,num)`

GETERRORMESSAGE 宏从提供的 %Status 代码 (sc) 返回由 num 指定的错误消息值的一部分。例如，num=1 返回 SQLCODE 错误号，num=2 返回错误消息文本。该宏需要 %occStatus.inc。

注：IRIS中新加，Cache中没有。

`ISERR(sc)`

如果提供的 %Status 代码 (sc) 是错误代码，则 ISERR 宏返回 True。否则，返回 False。该宏需要 %occStatus.inc。

`ISOK(sc)`

OK 宏创建一个 %Status 代码以表示成功完成。该宏需要 %occStatus.inc。

`Text(text, domain, language)`

Text 宏用于本地化。它在编译时生成一条新消息，并生成代码以在运行时检索该消息。该宏需要 %occMessages.inc。

`TextHTML(text, domain, language)`

TextHTML 宏用于本地化。它执行与文本宏相同的处理；然后它另外应用 HTML 转义。然后它返回结果字符串。该宏需要 %occMessages.inc。

`TextJS(text, domain, language)`

TextJS 宏用于本地化。它执行与文本宏相同的处理；然后它另外应用 JavaScript 转义。然后它返回结果字符串。该宏需要 %occMessages.inc。

`ThrowOnError(sc)`

ThrowOnError 宏计算指定的 %Status 代码 (sc)。如果 sc 表示错误状态，则 ThrowOnError 会执行 THROW 操作，类型为 %Exception.StatusException的异常抛出到异常处理程序。该宏需要 %occStatus.inc。

`THROWONERROR(sc, expr)`

THROWONERROR 宏计算表达式 (expr)，其中表达式的值假定为 %Status 代码；该宏将 %Status存储在作为 sc 传递的变量中的代码中。如果 %Status代码是错误，则 THROWONERROR 会执行 THROW 操作，将 %Exception.StatusException 类型的异常抛出到异常处理程序。该宏需要 %occStatus.inc。

`ThrowSQLCODE(sqlcode,message)`

ThrowSQLCODE 宏使用指定的 SQLCODE 和 Message 执行 THROW 操作，以将 %Exception.SQLO类型的异常抛出到异常处理程序。该宏需要 %occStatus.inc。

注：IRIS中新加，Cache中没有。

`ThrowSQLIfError(sqlcode,message)`

ThrowSQLIfError 宏使用指定的 SQLCODE 和 Message 执行 THROW 操作，以 %Exception.SQL类型的异常抛出到异常处理程序。如果 SQLCODE < 0（负数，表示错误），则会抛出此异常。该宏需要 %occStatus.inc。

注：IRIS中新加，Cache中没有。

`ThrowStatus(sc)`

ThrowStatus 宏使用指定的 %Status 代码 (sc) 执行 THROW 操作，以将 %Exception.StatusException 类型的异常抛出到异常处理程序。该宏需要%occStatus.inc。