Home
Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
Bit manipulation and testing functions
You can use this function to manipulate and to test a bit in a binary number.
SETOFF
The SETOFF function sets to zero a specified bit in a binary number.

Functions and Expressions
Use HCL Link functions and expressions to create component rules and map rules.
- Expressions and evaluations
  The documentation provided here describes HCL Link functions and expressions. Functions and expressions are used to create component rules and map rules.
- Using functions
  A function is an expression that generates an output by performing a certain operation on one or more inputs.
- Syntax of a function
  The following is an example of a function:
- Function argument syntax
  Arguments typically have some restrictions on the expression used for that argument.
- Character-set encoding functions
  Functions that use the HCL Link EXIT architecture convert data to the native character set of the platform as part of the function call.
- General functions
  There are several general functions you can call from map rule to process input.
- Bidirectional functions
  Bidirectional languages such as Arabic and Hebrew are languages in which the text is presented to the user ordered from right to left, but numbers and Latin alphabetic strings within the text are presented left to right.
- Bit manipulation and testing functions
  You can use this function to manipulate and to test a bit in a binary number.
  - SETOFF
    The SETOFF function sets to zero a specified bit in a binary number.
  - SETON
    You can use the SETON function to "turn on" a specific bit in a binary number.
  - TESTOFF
    The TESTOFF function tests a specified bit in a binary number item to see whether it is off.
  - TESTON
    The TESTON function tests a specified bit in a binary number to see if it is on.
- Cache functions
  Use cache functions to specify a value for each of the cache variables defined for a flow, and additionally, to alter an already specified value for a cache variable.
- Conversion functions
  You can use this function to convert an expression from one datatype to another datatype.
- Date/time functions
  You can use this function to perform various operations on date and time.
- Error handling functions
  You can use this function in evaluating the type of error during map execution.
- External interface functions
  You can use this function to retrieve data from a database from within in a map rule.
- Flow functions
  Use Flow functions to specify a value for each of the flow variables defined for a flow, and additionally, to alter an already specified value for a flow variable.
- Inspection functions
  You can use this function to test and inspect the object.
- Logical functions
  Logical functions provide a way to use logical conditions to display one of several values.
- Lookup and reference functions
  These function search operates by scanning the appropriate set of items in sequence, attempting to match the logical condition.
- Math and statistics functions
  Precede all MATHLIB functions with mathlib->
- Text functions
  These functions are used to convert the text item in a map rule.
- XML functions
  There are several XML functions that you can call from component rules and map rules to process input XML data.
- Custom functions
  From the Type Designer or Map Designer, you can create custom functions to call external libraries.
- Date and time format strings
  You can use the listed format strings for numbers, dates and times in functions such as the CURRENTDATETIME, FROMNUMBER, TONUMBER, FROMDATETIME, and TODATETIME.
- Number format strings
  You can create custom number formats by using the given format strings.
- RUN function return codes
  The RUN function return codes and messages might result when using the RUN function.
- Character set codes for CPACKAGE, CSERIESTOTEXT, and CTEXT
  The second argument of the CPACKAGE, CSERIESTOTEXT, and CTEXT functions specifies the character set of the output of the function. The value of the second argument (the character set of the object content), must be a valid character set code.

SETOFF

The SETOFF function sets to zero a specified bit in a binary number.

You can use this function to manipulate (turn off) a bit in a binary number.

Syntax:: SETOFF ( single-binary-number-expression, single-integer-expression )
Meaning:: SETOFF ( binary_number_to_change, bit_to_turn_off )
Returns:: A single binary number

The SETOFF function uses bit_to_turn_off to specify the bit of binary_number_to_change to be set to the value 0. The result is a binary number item of the same size as binary_number_to_change.

The value of bit_to_turn_off represents the position of the single bit in binary_number_to_change to be set off. (Bits are numbered from left to right, with the leftmost bit being bit 1.) If bit_to_turn_off is less than one or greater than the number of bits of binary_number_to_change, SETOFF returns binary_number_to_change unchanged.

Examples

SETOFF ( A , 16 )
Assume A is the two-byte binary value of "1" (which is all zeros except for bit 16). The binary representation of the value in A is 0001.

The result is the two-byte binary value, "0"
SETOFF ( A , 38 )
Results in the two-byte binary value "1", the original value of A, because bit 38 does not exist in A.