RequestParameterType Property

The type of the parameter.

Syntax

 sapclient.getRequestParameterType(index, [callback])
 sapclient.setRequestParameterType(index,  requestParameterType, [callback])

Possible Values

  0 (ptCharacters), 
  1 (ptDate), 
  2 (ptPackedDecimal), 
  3 (ptTime), 
  4 (ptBinary), 
  5 (ptTable), 
  6 (ptNumber), 
  7 (ptFloat), 
  8 (ptInteger), 
  9 (ptShort), 
  10 (ptByte), 
  14 (ptNull), 
  17 (ptStructure), 
  23 (ptDecF16), 
  24 (ptDecF34), 
  28 (ptXMLData), 
  29 (ptString), 
  30 (ptXString)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRequestParameterType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRequestParameterType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The type of the parameter.

A list of valid parameter types is shown below:


ptCharacters (0)	Character data.
ptDate (1)	A date in the format YYYYMMDD.
ptPackedDecimal (2)	Packed decimals are unique to the SAP system, and are treated as binary data by the class.
ptTime (3)	A time in the format HHMMSS.
ptBinary (4)	Raw binary data.
ptTable (5)	Handle to a table in memory.
ptNumber (6)	Numeric data formatted as a String.
ptDouble (7)	An 8-byte floating-point number (double).
ptInteger (8)	A 4-byte integer (int).
ptShort (9)	A 2-byte integer (short).
ptByte (10)	A 1-byte integer (byte).
ptNull (14)	An unsupported data type
ptStructure (17)	ABAP structure
ptDecF16 (23)	754r decimal floating point, 8 bytes
ptDecF34 (24)	754r decimal floating point, 16 bytes
ptXMLData (28)	Null terminated string containing an ABAP structure with XML
ptString (29)	Null terminated string
ptXString (30)	Null terminated string with length property in bytes

Note that the RequestParameterValue property will always contain a string representation of integer or floating point data. The class will convert between this string representation and the actual integer and float data expected by the SAP system.

The size of the array is controlled by the RequestParameterCount property.

This property is not available at design time.

Data Type

Integer