Imprint
2022 June Release

Actions of FSCEXPEXT@1.1001 Permanent link for this heading

Return Type

Signature

float

abs(
  float x,
  out retval float result)

float

acos(
  float x,
  out retval float result)

float

acosh(
  float x,
  out retval float result)

float

asin(
  float x,
  out retval float result)

float

asinh(
  float x,
  out retval float result)

float

atan(
  float x,
  out retval float result)

float

atan2(
  float y,
  float x,
  out retval float result)

float

atanh(
  float x,
  out retval float result)

dictionary[]

BackupTransactionVars(
  out retval dictionary[] txvars)

content

Base64Decode(
  content incont,
  out retval content outcont)

string

Base64Encode(
  content incont,
  out retval string base64string,
  optional boolean usemaxlinelength)

float

cbrt(
  float x,
  out retval float result)

float

ceil(
  float x,
  out retval float result)

string

CleanStr(
  string source,
  out retval string cleaned)

float

clz32(
  float x,
  out retval float result)

void

Commit(
  ref optional boolean allscopes,
  optional boolean savetxvars)

datetime

ConvertLocal(
  ref retval datetime value)

datetime

ConvertUTC(
  ref retval datetime value)

float

cos(
  float x,
  out retval float result)

float

cosh(
  float x,
  out retval float result)

string

CreateDigest(
  any incontent,
  out retval string hash,
  optional SecDigest digesttype,
  optional SecEncoding encoding)

any

Decrypt(
  ref retval any value,
  CipherType ciphertype,
  string password,
  optional SecEncoding encoding)

Content

Dict2Zip(
  dictionary dict,
  out retval Content zip)

any

Encrypt(
  ref retval any value,
  CipherType ciphertype,
  string password,
  optional SecEncoding encoding)

string

EncryptPassword(
  ref retval string password,
  HashType hashtype)

string

Escape(
  ref retval string str,
  optional string quote)

string

EscapeHTML(
  ref retval string str,
  optional boolean isattribute)

string

EscapeXML(
  ref retval string str)

any[]

EvaluateRestrictedExpression(
  string exprtext,
  ref any globalscope,
  ref any localscope,
  optional boolean useobjcategorycomponent,
  out retval any[] result)

any[]

EvaluateSecuredExpression(
  string exprtext,
  ref any globalscope,
  ref any localscope,
  optional boolean useobjcategorycomponent,
  out retval any[] result)

float

exp(
  float x,
  out retval float result)

float

expm1(
  float x,
  out retval float result)

string

FileNameEncode(
  string source,
  out retval string replaced)

float

floor(
  float x,
  out retval float result)

float

fround(
  float x,
  out retval float result)

string

GenerateUUID(
  out retval string uuid)

content

GetContentPart(
  content cont,
  ref integer maxsize,
  out retval content part)

integer

GetDateTimeDistance(
  datetime fromdate,
  datetime todate,
  ModifyDateTimeOperand operand,
  out retval integer distance)

string

GetDefaultStr(
  AttributeAggregateDef attrdef,
  out retval string str)

string

GetFileExtFromMIMEType(
  string mimetype,
  out retval string fileext)

datetime

GetFileModificationTime(
  content cont,
  out retval datetime modificationtime)

string

GetMIMETypeFromFileExt(
  string fileext,
  out retval string mimetype,
  out boolean mimetypefound)

integer

GetRandomNumber(
  optional integer max,
  out retval integer number)

string

GetRandomString(
  optional integer length,
  out retval string string)

string

GetSizeStr(
  integer kbs,
  out retval string result)

any[]

GetThreadActionParameter(
  Action action,
  integer parameteridx,
  out boolean hasaction,
  out retval any[] value)

object

GetTraceContext(
  out retval object context)

boolean

HasThreadActions(
  Action[] actionlist,
  out retval boolean result,
  out optional Action action)

void

HexColor2RGB(
  string hexcolor,
  out integer red,
  out integer green,
  out integer blue)

string

HexDecode(
  string encoded,
  out retval string decoded)

string

HexEncode(
  string source,
  out retval string encoded)

float

hypot(
  float x,
  float y,
  out retval float result)

float

imul(
  float x,
  float y,
  out retval float result)

void

InitializeRandom()

boolean

IsEmptyCSVLine(
  string line,
  string nullrep,
  out retval boolean result)

any

JSON2Value(
  string json,
  out retval any value,
  optional boolean allowinvalidutf8)

string

LocalDateTime2ISOStr(
  datetime localdatetime,
  out retval string datetimestring)

float

log(
  float x,
  out retval float result)

float

log10(
  float x,
  out retval float result)

float

log1p(
  float x,
  out retval float result)

float

log2(
  float x,
  out retval float result)

string

MakeCSVLine(
  string[] cells,
  string nullrep,
  out retval string str)

datetime

ModifyDateTime(
  ref retval datetime value,
  ModifyDateTimeOperand operand,
  ModifyDateTimeOperator operator,
  integer modifyvalue)

interface

Parse(
  any content,
  out retval interface xmldoc)

float

pow(
  float x,
  float y,
  out retval float result)

string

QPEncode(
  string string,
  out retval string qpstring)

void

RaiseError(
  ErrorMessage errormessage,
  optional string str1,
  optional string str2,
  optional string str3,
  optional string str4,
  optional string str5)

any

Random(
  ref retval any number,
  integer range)

float

random(
  out retval float result)

string[]

RegexCapture(
  string source,
  string pattern,
  optional string flags,
  out retval string[] result)

dictionary[]

RegexCaptureEx(
  string source,
  string pattern,
  optional string flags,
  out retval dictionary[] result)

boolean

RegexMatch(
  string source,
  string pattern,
  optional string flags,
  out retval boolean result)

string

RegexReplace(
  string source,
  string pattern,
  optional string flags,
  string replacement,
  out retval string result)

void

RestoreTransactionVars(
  dictionary[] txvars)

string

RGB2HexColor(
  integer red,
  integer green,
  integer blue,
  ref retval string hexcolor)

float

round(
  float x,
  out retval float result)

any

Round(
  ref retval any number,
  optional integer fractions)

void

SetFileModificationTime(
  content cont,
  datetime modificationtime)

float

sign(
  float x,
  out retval float result)

float

sin(
  float x,
  out retval float result)

float

sinh(
  float x,
  out retval float result)

void

Sleep(
  integer milliseconds)

float

sqrt(
  float x,
  out retval float result)

datetime

Str2DateTime(
  string str,
  out retval datetime value)

float

Str2Float(
  string str,
  out retval float value)

integer

Str2Integer(
  string str,
  out retval integer value)

string

StringReplace(
  ref retval string value,
  string[] patternlist,
  string replacement)

float

tan(
  float x,
  out retval float result)

float

tanh(
  float x,
  out retval float result)

string[]

Tokenize(
  string str,
  optional string separator,
  out retval string[] tokens)

string[]

TokenizeCSVFile(
  string str,
  string nullrep,
  out retval string[] lines)

string[]

TokenizeCSVLine(
  string str,
  string nullrep,
  out retval string[] cells)

void

Trace(
  string text,
  optional any value)

void

TraceCallStack()

void

TraceTransaction()

void

TraceValue(
  optional any value)

content

Transform(
  any xml,
  any xsl,
  optional dictionary data,
  out retval content transformed)

float

trunc(
  float x,
  out retval float result)

string

UnEscape(
  ref retval string str,
  optional string quote)

string

UnEscapeHTML(
  ref retval string str)

string

UnEscapeXML(
  ref retval string str)

string

URLDecode(
  string encodedurl,
  out retval string url)

string

URLEncode(
  string url,
  out retval string encodedurl,
  optional integer targetcharset)

void

Validate(
  any xml,
  any schema,
  optional dictionary schemas)

string

Value2JSON(
  any value,
  out retval string json,
  optional boolean fullrefs,
  optional JSONStructFormat[] formats)

string

Value2XML(
  any value,
  out retval string xml,
  optional boolean enrich,
  optional boolean fullrefs,
  optional boolean omitsurroundingnode)

void

VerifyPassword(
  string password,
  string hash)

any

XML2Value(
  any xml,
  out retval any value,
  optional boolean keepnamespaceprefixes,
  optional boolean version2)

dictionary

Zip2Dict(
  Content zip,
  out retval dictionary dict)


FSCEXPEXT@1.1001:abs Permanent link for this heading

Returns the absolute value of a number.

float FSCEXPEXT@1.1001:abs(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:acos Permanent link for this heading

Returns the arccosine of a number.

float FSCEXPEXT@1.1001:acos(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:acosh Permanent link for this heading

Returns the hyperbolic arccosine of a number.

float FSCEXPEXT@1.1001:acosh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:asin Permanent link for this heading

Returns the arcsine of a number.

float FSCEXPEXT@1.1001:asin(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:asinh Permanent link for this heading

Returns the hyperbolic arcsine of a number.

float FSCEXPEXT@1.1001:asinh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:atan Permanent link for this heading

Returns the arctangent of a number.

float FSCEXPEXT@1.1001:atan(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:atan2 Permanent link for this heading

Returns the arctangent of the quotient of its arguments.

float FSCEXPEXT@1.1001:atan2(
  float y,
  float x,
  out retval float result)

Name

Description

y

x

result

Additional Information


FSCEXPEXT@1.1001:atanh Permanent link for this heading

Returns the hyperbolic arctangent of a number.

float FSCEXPEXT@1.1001:atanh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:BackupTransactionVars Permanent link for this heading

Create a dictionary backup of the current transaction variables.

dictionary[] FSCEXPEXT@1.1001:BackupTransactionVars(
  out retval dictionary[] txvars)

Name

Description

txvars
the dictionary containing the backed up transaction variables

Additional Information


FSCEXPEXT@1.1001:Base64Decode Permanent link for this heading

Decodes a base64 encoded content.

content FSCEXPEXT@1.1001:Base64Decode(
  content incont,
  out retval content outcont)

Name

Description

incont
the base64 encoded content

outcont
the decoded content

Additional Information


FSCEXPEXT@1.1001:Base64Encode Permanent link for this heading

Encodes a given content in base64.

string FSCEXPEXT@1.1001:Base64Encode(
  content incont,
  out retval string base64string,
  optional boolean usemaxlinelength)

Name

Description

incont
the given content

base64string
the base64 encoded string

usemaxlinelength

Additional Information


FSCEXPEXT@1.1001:cbrt Permanent link for this heading

Returns the cube root of a number.

float FSCEXPEXT@1.1001:cbrt(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:ceil Permanent link for this heading

Returns the smallest integer greater than or equal to a number.

float FSCEXPEXT@1.1001:ceil(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:CleanStr Permanent link for this heading

OBSOLETE: Use strtrim() Cleans the leading and trailing white spaces from a string.

string FSCEXPEXT@1.1001:CleanStr(
  string source,
  out retval string cleaned)

Name

Description

source
the given string

cleaned
the cleaned string

Additional Information


FSCEXPEXT@1.1001:clz32 Permanent link for this heading

Returns the number of leading zeroes of a 32-bit integer.

float FSCEXPEXT@1.1001:clz32(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:Commit Permanent link for this heading

Commits the current transaction.

void FSCEXPEXT@1.1001:Commit(
  ref optional boolean allscopes,
  optional boolean savetxvars)

Name

Description

allscopes
true if all scopes should be committed

savetxvars
true if the current transaction variables should be kept

Additional Information


FSCEXPEXT@1.1001:ConvertLocal Permanent link for this heading

Converts the date time value to local time.

datetime FSCEXPEXT@1.1001:ConvertLocal(
  ref retval datetime value)

Name

Description

value
datetime value

Additional Information


FSCEXPEXT@1.1001:ConvertUTC Permanent link for this heading

Converts the date time value to UTC.

datetime FSCEXPEXT@1.1001:ConvertUTC(
  ref retval datetime value)

Name

Description

value
datetime value

Additional Information


FSCEXPEXT@1.1001:cos Permanent link for this heading

Returns the cosine of a number.

float FSCEXPEXT@1.1001:cos(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:cosh Permanent link for this heading

Returns the hyperbolic cosine of a number.

float FSCEXPEXT@1.1001:cosh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:CreateDigest Permanent link for this heading

Creates a digest from a source content.

string FSCEXPEXT@1.1001:CreateDigest(
  any incontent,
  out retval string hash,
  optional SecDigest digesttype,
  optional SecEncoding encoding)

Name

Description

incontent
source content

hash
resulting digest

digesttype
digest type (default SHA1 digest)

encoding
result encoding (default hex encoding)

Additional Information


FSCEXPEXT@1.1001:Decrypt Permanent link for this heading

Decrypts a value using the given cipher type.

any FSCEXPEXT@1.1001:Decrypt(
  ref retval any value,
  CipherType ciphertype,
  string password,
  optional SecEncoding encoding)

Name

Description

value
the value can be a content or a string. In case of a string the given cipher text is expected as specified.

ciphertype
a symmetric block cipher algorithm.

password
the password which is used to derive the key and the initialization vector.

encoding
the encoding to use for a string value. Default is EncodingBase64.

Additional Information


FSCEXPEXT@1.1001:Dict2Zip Permanent link for this heading

Creates a zip file from a dictionary.

Content FSCEXPEXT@1.1001:Dict2Zip(
  dictionary dict,
  out retval Content zip)

Name

Description

dict
the dictionary

zip
the resulting zip file

Additional Information


FSCEXPEXT@1.1001:Encrypt Permanent link for this heading

Encrypts a value using the given cipher type.

any FSCEXPEXT@1.1001:Encrypt(
  ref retval any value,
  CipherType ciphertype,
  string password,
  optional SecEncoding encoding)

Name

Description

value
the value can be a content or a string. In case of a string the resulting cipher text is encoded as specified.

ciphertype
a symmetric block cipher algorithm.

password
the password which is used to derive the key and the initialization vector.

encoding
the encoding to use for a string value. Default is EncodingBase64.

Additional Information


FSCEXPEXT@1.1001:EncryptPassword Permanent link for this heading

Encrypts a password using the given hash type.

string FSCEXPEXT@1.1001:EncryptPassword(
  ref retval string password,
  HashType hashtype)

Name

Description

password
the password which should be encrypted.

hashtype
the password hash type.

Additional Information


FSCEXPEXT@1.1001:Escape Permanent link for this heading

Escapes the characters backslash, single quote and double quote in the given string and quote if specified. A backslash is considered as the escape character.

string FSCEXPEXT@1.1001:Escape(
  ref retval string str,
  optional string quote)

Name

Description

str
the string to be escaped

quote
the character to be used for quoting. Must be a single quote or a double quote.

Additional Information


FSCEXPEXT@1.1001:EscapeHTML Permanent link for this heading

Escapes the string to be used in html tags

string FSCEXPEXT@1.1001:EscapeHTML(
  ref retval string str,
  optional boolean isattribute)

Name

Description

str
the string to be escaped

isattribute
the result is used as HTML attribute value

Additional Information


FSCEXPEXT@1.1001:EscapeXML Permanent link for this heading

Escapes the string to be used in xml tags

string FSCEXPEXT@1.1001:EscapeXML(
  ref retval string str)

Name

Description

str
the string to be escaped

Additional Information


FSCEXPEXT@1.1001:EvaluateRestrictedExpression Permanent link for this heading

Evaluates an expression in secured and restricted mode.
For parsing, the following flags are used: COOPF_PARSESHORTREFERENCE|COOPF_PARSEDATEONLY|COOPF_USEALIASES
For evaluating, the following flags are used: COOEF_SECURED|COOEF_RESTRICTED

any[] FSCEXPEXT@1.1001:EvaluateRestrictedExpression(
  string exprtext,
  ref any globalscope,
  ref any localscope,
  optional boolean useobjcategorycomponent,
  out retval any[] result)

Name

Description

exprtext
the expression text

globalscope
the global scope

localscope
the local scope

useobjcategorycomponent
if the object this action is executed for has a category and the category belongs to a software component, this software component is used to allow short references during expression parsing.

result
the result

Additional Information


FSCEXPEXT@1.1001:EvaluateSecuredExpression Permanent link for this heading

Evaluates an expression in secured mode.
For parsing, the following flags are used: COOPF_PARSESHORTREFERENCE|COOPF_PARSEDATEONLY|COOPF_USEALIASES
For evaluating, the following flags are used: COOEF_SECURED

any[] FSCEXPEXT@1.1001:EvaluateSecuredExpression(
  string exprtext,
  ref any globalscope,
  ref any localscope,
  optional boolean useobjcategorycomponent,
  out retval any[] result)

Name

Description

exprtext
the expression text

globalscope
the global scope

localscope
the local scope

useobjcategorycomponent
if the object this action is executed for has a category and the category belongs to a software component, this software component is used to allow short references during expression parsing.

result
the result

Additional Information


FSCEXPEXT@1.1001:exp Permanent link for this heading

Returns E^x, where x is the argument, and E is Euler's constant (2.718...), the base of the natural logarithm.

float FSCEXPEXT@1.1001:exp(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:expm1 Permanent link for this heading

Returns subtracting 1 from exp(x).

float FSCEXPEXT@1.1001:expm1(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:FileNameEncode Permanent link for this heading

Converts a given string to a valid file name string.

string FSCEXPEXT@1.1001:FileNameEncode(
  string source,
  out retval string replaced)

Name

Description

source
the given string

replaced
the valid file name

Additional Information


FSCEXPEXT@1.1001:floor Permanent link for this heading

Returns the largest integer less than or equal to a number.

float FSCEXPEXT@1.1001:floor(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:fround Permanent link for this heading

Returns the nearest single precision float representation of a number.

float FSCEXPEXT@1.1001:fround(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:GenerateUUID Permanent link for this heading

Generates a UUID.

string FSCEXPEXT@1.1001:GenerateUUID(
  out retval string uuid)

Name

Description

uuid
the uuid string

Additional Information


FSCEXPEXT@1.1001:GetContentPart Permanent link for this heading

Retrieves the head of a content.

content FSCEXPEXT@1.1001:GetContentPart(
  content cont,
  ref integer maxsize,
  out retval content part)

Name

Description

cont
original content

maxsize
maximal size to retrieve

part
content part

Additional Information


FSCEXPEXT@1.1001:GetDateTimeDistance Permanent link for this heading

Retrieves the distance between two dates

integer FSCEXPEXT@1.1001:GetDateTimeDistance(
  datetime fromdate,
  datetime todate,
  ModifyDateTimeOperand operand,
  out retval integer distance)

Name

Description

fromdate
the start date

todate
the end date

operand
the distance operand

distance
the distance

Additional Information


FSCEXPEXT@1.1001:GetDefaultStr Permanent link for this heading

Retrieves the string in the default language

string FSCEXPEXT@1.1001:GetDefaultStr(
  AttributeAggregateDef attrdef,
  out retval string str)

Name

Description

attrdef
the attribute definition containing the multi language string

str
the resulting string

Additional Information


FSCEXPEXT@1.1001:GetFileExtFromMIMEType Permanent link for this heading

Retrieves the file extension from a MIME type.

string FSCEXPEXT@1.1001:GetFileExtFromMIMEType(
  string mimetype,
  out retval string fileext)

Name

Description

mimetype
the given MIME type

fileext
the file extension

Additional Information


FSCEXPEXT@1.1001:GetFileModificationTime Permanent link for this heading

OBSOLETE: Use ICooContent::GetDate() instead. Retrieves the modification time of a content

datetime FSCEXPEXT@1.1001:GetFileModificationTime(
  content cont,
  out retval datetime modificationtime)

Name

Description

cont

modificationtime

Additional Information


FSCEXPEXT@1.1001:GetMIMETypeFromFileExt Permanent link for this heading

Retrieves the MIME type from a file extension.

string FSCEXPEXT@1.1001:GetMIMETypeFromFileExt(
  string fileext,
  out retval string mimetype,
  out boolean mimetypefound)

Name

Description

fileext
the file extension

mimetype
the MIME type

mimetypefound

Additional Information


FSCEXPEXT@1.1001:GetRandomNumber Permanent link for this heading

Generates a positive random number less than the specified maximum.

integer FSCEXPEXT@1.1001:GetRandomNumber(
  optional integer max,
  out retval integer number)

Name

Description

max
the exclusive upper bound. The value must be greater than zero

number
the random number

Additional Information


FSCEXPEXT@1.1001:GetRandomString Permanent link for this heading

Generates a random string with the given length which contains only printable ASCII characters.

string FSCEXPEXT@1.1001:GetRandomString(
  optional integer length,
  out retval string string)

Name

Description

length
the string length. The value must be greater than zero

string
the random string

Additional Information


FSCEXPEXT@1.1001:GetSizeStr Permanent link for this heading

Formats incoming kilobytes to KB, MB and GB with one (optional) decimal place.

string FSCEXPEXT@1.1001:GetSizeStr(
  integer kbs,
  out retval string result)

Name

Description

kbs
the kilobytes of a file

result
the formated string

Additional Information


FSCEXPEXT@1.1001:GetThreadActionParameter Permanent link for this heading

Retrieves the parameter value of a specific action in the call stack of the current thread.

any[] FSCEXPEXT@1.1001:GetThreadActionParameter(
  Action action,
  integer parameteridx,
  out boolean hasaction,
  out retval any[] value)

Name

Description

action
the action to search for

parameteridx
the index of the parameter

hasaction
true if the action appears in the call stack of the current thread.

value
the parameter value of the found action

Additional Information


FSCEXPEXT@1.1001:GetTraceContext Permanent link for this heading

Determine custom trace context

object FSCEXPEXT@1.1001:GetTraceContext(
  out retval object context)

Name

Description

context
return value of current context or null.

Additional Information


FSCEXPEXT@1.1001:HasThreadActions Permanent link for this heading

Checks whether one of the actions in actions appears in the call stack of the current thread.

boolean FSCEXPEXT@1.1001:HasThreadActions(
  Action[] actionlist,
  out retval boolean result,
  out optional Action action)

Name

Description

actionlist
list of actions

result
true if one of the actions appears in the call stack of the current thread.

action
returns one of the actions if found on the call stack of the current thread and null otherwise.

Additional Information


FSCEXPEXT@1.1001:HexColor2RGB Permanent link for this heading

Converts the color code in a hex triplet to its RGB values.

void FSCEXPEXT@1.1001:HexColor2RGB(
  string hexcolor,
  out integer red,
  out integer green,
  out integer blue)

Name

Description

hexcolor
the color code as a hex triplet (like #abcd01)

red
the red value (first byte)

green
the green value (second byte)

blue
the blue value (third byte)

Additional Information


FSCEXPEXT@1.1001:HexDecode Permanent link for this heading

Decodes a hex encoded string.

string FSCEXPEXT@1.1001:HexDecode(
  string encoded,
  out retval string decoded)

Name

Description

encoded
the hex encoded string

decoded
the decoded string

Additional Information


FSCEXPEXT@1.1001:HexEncode Permanent link for this heading

Encodes a given string in hex.

string FSCEXPEXT@1.1001:HexEncode(
  string source,
  out retval string encoded)

Name

Description

source
the given string

encoded
the hex encoded string

Additional Information


FSCEXPEXT@1.1001:hypot Permanent link for this heading

Returns the square root of the sum of squares of its arguments.

float FSCEXPEXT@1.1001:hypot(
  float x,
  float y,
  out retval float result)

Name

Description

x

y

result

Additional Information


FSCEXPEXT@1.1001:imul Permanent link for this heading

Returns the result of a 32-bit integer multiplication.

float FSCEXPEXT@1.1001:imul(
  float x,
  float y,
  out retval float result)

Name

Description

x

y

result

Additional Information


FSCEXPEXT@1.1001:InitializeRandom Permanent link for this heading

OBSOLETE: Use GetRandomNumber instead. Initializes the random generator based on the current time.

void FSCEXPEXT@1.1001:InitializeRandom()

Additional Information


FSCEXPEXT@1.1001:IsEmptyCSVLine Permanent link for this heading

Checks whether a line in a csv file is empty.

boolean FSCEXPEXT@1.1001:IsEmptyCSVLine(
  string line,
  string nullrep,
  out retval boolean result)

Name

Description

line
the line from a csv file.

nullrep
the string representing a blank cell

result
true if the line from a csv file is empty.

Additional Information


FSCEXPEXT@1.1001:JSON2Value Permanent link for this heading

Converts a JSON string to a value.

any FSCEXPEXT@1.1001:JSON2Value(
  string json,
  out retval any value,
  optional boolean allowinvalidutf8)

Name

Description

json
the JSON string

value
the created value

allowinvalidutf8
invalid utf8 is allowed

Additional Information


FSCEXPEXT@1.1001:LocalDateTime2ISOStr Permanent link for this heading

Converts a local datetime to an ISO string

string FSCEXPEXT@1.1001:LocalDateTime2ISOStr(
  datetime localdatetime,
  out retval string datetimestring)

Name

Description

localdatetime
a local date time

datetimestring
the local date time as ISO string

Additional Information


FSCEXPEXT@1.1001:log Permanent link for this heading

Returns the natural logarithm (loge, also ln) of a number.

float FSCEXPEXT@1.1001:log(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:log10 Permanent link for this heading

Returns the base 10 logarithm of a number.

float FSCEXPEXT@1.1001:log10(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:log1p Permanent link for this heading

Returns the natural logarithm (loge, also ln) of 1 + x for a number x.

float FSCEXPEXT@1.1001:log1p(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:log2 Permanent link for this heading

Returns the base 2 logarithm of a number.

float FSCEXPEXT@1.1001:log2(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:MakeCSVLine Permanent link for this heading

Makes a line for a CSV line from a list of cell values.

string FSCEXPEXT@1.1001:MakeCSVLine(
  string[] cells,
  string nullrep,
  out retval string str)

Name

Description

cells
the list of cell values of the CSV line

nullrep
the string representing a blank cell

str
the CSV line

Additional Information


FSCEXPEXT@1.1001:ModifyDateTime Permanent link for this heading

Modifies a date time value with the given operation.

datetime FSCEXPEXT@1.1001:ModifyDateTime(
  ref retval datetime value,
  ModifyDateTimeOperand operand,
  ModifyDateTimeOperator operator,
  integer modifyvalue)

Name

Description

value
the date time vale

operand
the operand

operator
the operator

modifyvalue
the value which is to be applied

Additional Information


FSCEXPEXT@1.1001:Parse Permanent link for this heading

Parse content and return xml document.

interface FSCEXPEXT@1.1001:Parse(
  any content,
  out retval interface xmldoc)

Name

Description

content
string, content aggregate or content

xmldoc
the resulting XmlDocument

Additional Information


FSCEXPEXT@1.1001:pow Permanent link for this heading

Returns base to the exponent power, that is, baseexponent.

float FSCEXPEXT@1.1001:pow(
  float x,
  float y,
  out retval float result)

Name

Description

x

y

result

Additional Information


FSCEXPEXT@1.1001:QPEncode Permanent link for this heading

Encodes a given string in quoted printable.

string FSCEXPEXT@1.1001:QPEncode(
  string string,
  out retval string qpstring)

Name

Description

string
the given string

qpstring
the quoted printable encoded string

Additional Information


FSCEXPEXT@1.1001:RaiseError Permanent link for this heading

Raises an error.

void FSCEXPEXT@1.1001:RaiseError(
  ErrorMessage errormessage,
  optional string str1,
  optional string str2,
  optional string str3,
  optional string str4,
  optional string str5)

Name

Description

errormessage
the error message object

str1
optional parameter for the error message

str2
optional parameter for the error message

str3
optional parameter for the error message

str4
optional parameter for the error message

str5
optional parameter for the error message

Additional Information


FSCEXPEXT@1.1001:Random Permanent link for this heading

OBSOLETE: Use GetRandomNumber instead. Generates a random number between 0 and range.

any FSCEXPEXT@1.1001:Random(
  ref retval any number,
  integer range)

Name

Description

number
set any number as input to specify the type of the resulting value. Default is INTEGER

range
the range, default is 10

Additional Information


FSCEXPEXT@1.1001:random Permanent link for this heading

Returns a pseudo-random number between 0 and 1. See InitializeRandom.

float FSCEXPEXT@1.1001:random(
  out retval float result)

Name

Description

result

Additional Information


FSCEXPEXT@1.1001:RegexCapture Permanent link for this heading

Captures matching strings in a string using a regular expression.

string[] FSCEXPEXT@1.1001:RegexCapture(
  string source,
  string pattern,
  optional string flags,
  out retval string[] result)

Name

Description

source
input string

pattern
regex pattern

flags
regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.

result
resulting strings

Additional Information


FSCEXPEXT@1.1001:RegexCaptureEx Permanent link for this heading

Captures matches (full match and matching groups) in a string using a regular expression.

Example The expression 
coouser.RegexCaptureEx("ID-01-ABC, ID-02-", "(ID-[0-9]*)-([A-Z]*)", "g");
will return the following value 

 [
   { match : "ID-01-ABC", group1 : "ID-01", group2 : "ABC" },
   { match : "ID-02-", group1 : "ID-02", group2 : "" }
 ]

dictionary[] FSCEXPEXT@1.1001:RegexCaptureEx(
  string source,
  string pattern,
  optional string flags,
  out retval dictionary[] result)

Name

Description

source
input string

pattern
regex pattern

flags
regex flags. No flags are added by default.

result
resulting matches

Additional Information


FSCEXPEXT@1.1001:RegexMatch Permanent link for this heading

Checks for matches in a string using a regular expression. This action does not provide the matching strings, only a boolean result. If the matching strings itself are needed, use FSCEXPREX@1.1001:RegexCapture.

boolean FSCEXPEXT@1.1001:RegexMatch(
  string source,
  string pattern,
  optional string flags,
  out retval boolean result)

Name

Description

source
input string

pattern
regex pattern

flags
regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.

result
true if the regex matches

Additional Information


FSCEXPEXT@1.1001:RegexReplace Permanent link for this heading

Manipulates a string using a regular expression.

string FSCEXPEXT@1.1001:RegexReplace(
  string source,
  string pattern,
  optional string flags,
  string replacement,
  out retval string result)

Name

Description

source
input string

pattern
regex pattern

flags
regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.

replacement
replacement string

result
resulting string

Additional Information


FSCEXPEXT@1.1001:RestoreTransactionVars Permanent link for this heading

Restores the backed up transaction variables into the current transaction.

void FSCEXPEXT@1.1001:RestoreTransactionVars(
  dictionary[] txvars)

Name

Description

txvars
the backed up transaction variables dictionary

Additional Information


FSCEXPEXT@1.1001:RGB2HexColor Permanent link for this heading

Converts a color code in RGB to its representation as hex triplet.

string FSCEXPEXT@1.1001:RGB2HexColor(
  integer red,
  integer green,
  integer blue,
  ref retval string hexcolor)

Name

Description

red
the red value (0 - 255)

green
the green value (0 - 255)

blue
the blue value (0 - 255)

hexcolor

Additional Information


FSCEXPEXT@1.1001:round Permanent link for this heading

Returns the value of a number rounded to the nearest integer.
Note: this function rounds to the next integer away from zero (differs from ECMAScript).
Eg. round(3.5) == 4
Eg. round(-3.5) == -4

float FSCEXPEXT@1.1001:round(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:Round Permanent link for this heading

Rounds a currency or a floating point number.

any FSCEXPEXT@1.1001:Round(
  ref retval any number,
  optional integer fractions)

Name

Description

number
the number (currency, float or string)

fractions
the number of fractions (zero if omitted)

Additional Information


FSCEXPEXT@1.1001:SetFileModificationTime Permanent link for this heading

Sets the modification time of the given content.

void FSCEXPEXT@1.1001:SetFileModificationTime(
  content cont,
  datetime modificationtime)

Name

Description

cont
the content on which to operate

modificationtime
the modification time that should be set on the content

Additional Information


FSCEXPEXT@1.1001:sign Permanent link for this heading

Returns the sign of the x, indicating whether x is positive, negative or zero.

float FSCEXPEXT@1.1001:sign(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:sin Permanent link for this heading

Returns the sine of a number.

float FSCEXPEXT@1.1001:sin(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:sinh Permanent link for this heading

Returns the hyperbolic sine of a number.

float FSCEXPEXT@1.1001:sinh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:Sleep Permanent link for this heading

Waits for a given time.

void FSCEXPEXT@1.1001:Sleep(
  integer milliseconds)

Name

Description

milliseconds
time to sleep

Additional Information


FSCEXPEXT@1.1001:sqrt Permanent link for this heading

Returns the positive square root of a number.

float FSCEXPEXT@1.1001:sqrt(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:Str2DateTime Permanent link for this heading

Converts a string to a date time using the current locale information

datetime FSCEXPEXT@1.1001:Str2DateTime(
  string str,
  out retval datetime value)

Name

Description

str
the string

value
the result

Additional Information


FSCEXPEXT@1.1001:Str2Float Permanent link for this heading

Converts a string to a float using the current locale information

float FSCEXPEXT@1.1001:Str2Float(
  string str,
  out retval float value)

Name

Description

str
the string

value
the result

Additional Information


FSCEXPEXT@1.1001:Str2Integer Permanent link for this heading

Converts a string to an integer using the current locale information

integer FSCEXPEXT@1.1001:Str2Integer(
  string str,
  out retval integer value)

Name

Description

str
the string

value
the result

Additional Information


FSCEXPEXT@1.1001:StringReplace Permanent link for this heading

Replaces a given string within another string.

string FSCEXPEXT@1.1001:StringReplace(
  ref retval string value,
  string[] patternlist,
  string replacement)

Name

Description

value
the given string

patternlist
the list of patterns

replacement
the string used as replacement

Additional Information


FSCEXPEXT@1.1001:tan Permanent link for this heading

Returns the tangent of a number.

float FSCEXPEXT@1.1001:tan(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:tanh Permanent link for this heading

Returns the hyperbolic tangent of a number.

float FSCEXPEXT@1.1001:tanh(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:Tokenize Permanent link for this heading

Tokenizes the given string using separator characters. Strings enclosed in single or double quotes are kept as single tokens. A backslash is considered as the escape character.

string[] FSCEXPEXT@1.1001:Tokenize(
  string str,
  optional string separator,
  out retval string[] tokens)

Name

Description

str
the string to be tokenized

separator
the separator characters used to tokenize. If null, all white space characters are assumed

tokens
the list of extracted tokens

Additional Information


FSCEXPEXT@1.1001:TokenizeCSVFile Permanent link for this heading

Tokenizes the given string representing a CSV file to the lines of the file.

string[] FSCEXPEXT@1.1001:TokenizeCSVFile(
  string str,
  string nullrep,
  out retval string[] lines)

Name

Description

str
the string representing the CSV file

nullrep
the string representing a blank line

lines
the list of extracted lines of the CSV file

Additional Information


FSCEXPEXT@1.1001:TokenizeCSVLine Permanent link for this heading

Tokenizes the given string representing a CSV line to the cell values of the line.

string[] FSCEXPEXT@1.1001:TokenizeCSVLine(
  string str,
  string nullrep,
  out retval string[] cells)

Name

Description

str
the string representing the CSV line

nullrep
the string representing a blank cell

cells
the list of extracted cell values of the CSV line

Additional Information


FSCEXPEXT@1.1001:Trace Permanent link for this heading

Custom trace for string with optional value
If the call of object.GetTraceContext returns a trace context object, a trace entry is generated.

void FSCEXPEXT@1.1001:Trace(
  string text,
  optional any value)

Name

Description

text
get trace lines for this object

value
optional value or value list

Additional Information


FSCEXPEXT@1.1001:TraceCallStack Permanent link for this heading

Traces the current call stack

void FSCEXPEXT@1.1001:TraceCallStack()

Additional Information


FSCEXPEXT@1.1001:TraceTransaction Permanent link for this heading

Traces the current transaction variables.

void FSCEXPEXT@1.1001:TraceTransaction()

Additional Information


FSCEXPEXT@1.1001:TraceValue Permanent link for this heading

Traces the value.

void FSCEXPEXT@1.1001:TraceValue(
  optional any value)

Name

Description

value
the value

Additional Information


FSCEXPEXT@1.1001:Transform Permanent link for this heading

Transform XML with the given transformation

content FSCEXPEXT@1.1001:Transform(
  any xml,
  any xsl,
  optional dictionary data,
  out retval content transformed)

Name

Description

xml
Object with content, string, content aggregate or content

xsl
Object with content, string, content aggregate or content

data
dictionary with additional variables

transformed

Additional Information


FSCEXPEXT@1.1001:trunc Permanent link for this heading

Returns the integer part of the number x, removing any fractional digits.

float FSCEXPEXT@1.1001:trunc(
  float x,
  out retval float result)

Name

Description

x

result

Additional Information


FSCEXPEXT@1.1001:UnEscape Permanent link for this heading

Unescapes the characters backslash, single quote and double quote in the given string and unquote if specified. A backslash is considered as the escape character.

string FSCEXPEXT@1.1001:UnEscape(
  ref retval string str,
  optional string quote)

Name

Description

str
the string to be unescaped

quote
the character to be used for unquoting. Must be a single quote or a double quote.

Additional Information


FSCEXPEXT@1.1001:UnEscapeHTML Permanent link for this heading

Unescapes the string used in html tags

string FSCEXPEXT@1.1001:UnEscapeHTML(
  ref retval string str)

Name

Description

str
the string to be unescaped

Additional Information


FSCEXPEXT@1.1001:UnEscapeXML Permanent link for this heading

Unescapes the string used in xml tags

string FSCEXPEXT@1.1001:UnEscapeXML(
  ref retval string str)

Name

Description

str
the string to be unescaped

Additional Information


FSCEXPEXT@1.1001:URLDecode Permanent link for this heading

Decodes a URL encoded string.

string FSCEXPEXT@1.1001:URLDecode(
  string encodedurl,
  out retval string url)

Name

Description

encodedurl
the URL encoded string

url
the decoded string

Additional Information


FSCEXPEXT@1.1001:URLEncode Permanent link for this heading

Encodes a string URL style.

string FSCEXPEXT@1.1001:URLEncode(
  string url,
  out retval string encodedurl,
  optional integer targetcharset)

Name

Description

url
the unencoded string

encodedurl
the URL encoded string

targetcharset
optional the character set of the result (before encoding)

Additional Information


FSCEXPEXT@1.1001:Validate Permanent link for this heading

Validate XML against the given schema, additional schemas can be supplied with the resolver dicictionary

void FSCEXPEXT@1.1001:Validate(
  any xml,
  any schema,
  optional dictionary schemas)

Name

Description

xml
Object with content, string, content aggregate or content

schema
Object with content, string, content aggregate or content

schemas
dictionary with additional schemas

Additional Information


FSCEXPEXT@1.1001:Value2JSON Permanent link for this heading

Converts a value to a JSON string.

string FSCEXPEXT@1.1001:Value2JSON(
  any value,
  out retval string json,
  optional boolean fullrefs,
  optional JSONStructFormat[] formats)

Name

Description

value
any value that should be converted to a JSON value

json
the JSON string

fullrefs
if true full references in underscore notation are used for JSON identifiers

formats
list of formatting information for structured types (see JSONStructFormat)

Additional Information


FSCEXPEXT@1.1001:Value2XML Permanent link for this heading

Converts a value to an XML string. The XML string contains a node "data" that contains the representation of the value.
If omitsurroundingnode is true no additional node "data" is generated.
The value is stored in XML nodes. If the value is a dictionary or an aggregate, all the members of those values are converted recursively.
It is also possible to add XML attributes to an XML node if a dictionary is converted. For each key (i.e. "key") in a dictionary the content of a key with the same name and the character "@" as prefix (i.e. "@key") is treated as a dictionary containing the XML attributes. If the key is a list then the entry for the XML attributes should be a list, too.


sample string value:
coouser.Value2XML("test")
resulting XML string:
<data>
  <value>test</value>
</data>

sample dictionary value:
dictionary dict = {
  key1: "value1",
  key2: "value2"
}
coouser.Value2XML(dict)
resulting XML string:
<data>
  <key1>value1</key1>
  <key2>value2</key2>
</data>

sample object value in a dictionary:
dictionary dict = {
  user: coouser
}
coouser.Value2XML(dict)
resulting XML string:
<data>
  <user>
    <objname>...</objname>
    <objaddress>...</objaddress>
  </user>
</data>

sample XML attribute:
dictionary dict = {
  node: { key: "value" }
}
dict.SetEntry("@node", { id: "attrval" });
coouser.Value2XML(dict);
resulting XML string:
<data>
  <node id="attrval">
    <key>value</key>
  </node>
</data>

string FSCEXPEXT@1.1001:Value2XML(
  any value,
  out retval string xml,
  optional boolean enrich,
  optional boolean fullrefs,
  optional boolean omitsurroundingnode)

Name

Description

value
any value that should be converted to an XML string

xml
the XML string

enrich
if true values are enriched with the following XML attributes:
enums  
id the integer value of the enum value
aggregates  
id an internally generated unique id of the aggregate
display the display string of the aggregate value if the attribute definition of that aggregate has a display action
dictionaries  
id an internally generated unique id of the dictionary
objects  
id the address of the object (objaddress)
If user-defined XML attributes are specified, the generation of the XML attributes listed above is suppressed.
If the value is a list (i.e. a list of aggregates) and the attribute definition of that value has a display action, then a single XML node with is generated with the display XML attribute containing the display value for the whole list. Each entry in the list is generated as a child XML node with the name "entry" containing the individual values of the list entries.
For enum values the text of the XML node is the value of typeenumtext in the appropriate language of the caller.
For object values the text of the XML node is the value of objname, so no child XML nodes are generated as it would be the case if enrich is not specified.

fullrefs
if true full references in underscore notation are used for names of XML nodes.

omitsurroundingnode
if true no additional node "data" is generated.

Additional Information


FSCEXPEXT@1.1001:VerifyPassword Permanent link for this heading

Verifies if a password matches the given hash. The error message ERR_INVALID_PASSWORD is thrown if the password does not match the hash.

void FSCEXPEXT@1.1001:VerifyPassword(
  string password,
  string hash)

Name

Description

password
the password which should be verified.

hash
the password hash.

Additional Information


FSCEXPEXT@1.1001:XML2Value Permanent link for this heading

Converts an XML content or string to a value (hierarchical dictionary containing string values).

any FSCEXPEXT@1.1001:XML2Value(
  any xml,
  out retval any value,
  optional boolean keepnamespaceprefixes,
  optional boolean version2)

Name

Description

xml
the XML as content or string

value
the dictionary

keepnamespaceprefixes
if true namespace prefixes are kept in dictionary identifiers

version2
use new dictionary format

Additional Information


FSCEXPEXT@1.1001:Zip2Dict Permanent link for this heading

Creates a dictionary from a zip file.

dictionary FSCEXPEXT@1.1001:Zip2Dict(
  Content zip,
  out retval dictionary dict)

Name

Description

zip
the zip file

dict
the resulting dictionary

Additional Information