SapParam Type

Parameter used in remote function calls.

Remarks

This type contains a single parameter, which is to be sent to the R/3 system when executing a remote function. For a request parameter you may specify the Value or leave it blank. Response parameters should be sent with the Value empty, as the remote function will fill in the value.

Fields

Length
Integer

This contains the length of the current parameter.

Typically this does not need to be set, however when using SapServer, and the ParamType is set to a something like ptNumber, the parameter's length needs to be set to a value other than the default value of 514, or it will cause an error.

Name
String

Name of the parameter.

ParamType
ParamTypes

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 component.
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 field in bytes

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

TableIndex
Integer

This corresponds to the TableIndex of the table that is to be passed as a parameter or as a parameter from NetWeaver. This will be used if ParamType is set to ptTable.

TableType
String

If ParamType is set to ptTable, this field will correspond with the TableType that corresponds to TableIndex.

Value
String

Actual data sent to or received from remote function call.

For request parameters, you should set this value before calling the remote function. For response properties, this field will contain the value returned by the remote function. Integer and floating-point should be specified as strings, the component will convert the string representation into the value the remote function expects.

ValueB
Byte[]

Actual data sent to or received from remote function call.

Constructors

[VB.NET]
Public SapParam()

[C#]
public SapParam();

[VB.NET]
Public SapParam(ByVal Name As String, ByVal Value As String, ByVal Length As Integer, ByVal ParamType As ParamTypes)

[C#]
public SapParam(string name, byte[] value, int length, ParamTypes paramType);

[VB.NET]
Public SapParam(ByVal Name As String, ByVal Value As String, ByVal ParamType As ParamTypes)

[C#]
public SapParam(string name, string value, ParamTypes paramType);