GetShort Function

Action

Retrieves a short value (2-byte signed integer value) from a specified data structure at a specified position. You must declare a BDL string before using this function.

Include file

Kernel.bdh

Syntax

GetShort( in sString : string,
          in nPos : number,
          in nByteOrder : number optional ) : number;

Return value

short value

Parameter	Description
sString	BDL string corresponding to the data structure
nPos	Starting position in the BDL string, where the first position is 1 (not 0)
nByteOrder	Specifies the byte order that is applied when a value is retrieved (optional). This parameter can be one of the following: OPT_LITTLE_ENDIAN. Microsoft byte order (default). OPT_BIG_ENDIAN. Network, Apple, Java byte order.

Parameter

Description

sString

BDL string corresponding to the data structure

nPos

Starting position in the BDL string, where the first position is 1 (not 0)

nByteOrder

Specifies the byte order that is applied when a value is retrieved (optional). This parameter can be one of the following:

OPT_LITTLE_ENDIAN. Microsoft byte order (default).
OPT_BIG_ENDIAN. Network, Apple, Java byte order.

Example

dcltrans
  transaction TGetShort
  const
    SIZE_STRUCT := 32;
  var
    myBDLstring : string(SIZE_STRUCT);
    nShort : number;
  begin
  ...
    // Retrieve a 2-byte signed integer value from position 2
    // in the BDL string myBDLstring and thereby (through mapping) get
    // the element myShort in Struct1
    nShort := GetShort(myBDLstring, 2);
    write("myShort = "); write(nShort); writeln;
  end TGetShort;

Output

myShort = 209