DynamicRequestParameter

Overview

Used to represent a single Parameter in a DynamicRequest.

You will usually not instantiate instances of this class yourself, but work with parameters in DynamicRequest.Parameters collection.

This component is a part of Data Abstract, however the namespace is called Namespace RemObjects.SDK. It is contained in DataAbstract.dll.

Location

 

constructor

 

constructor

 

DynamicRequestParameter()

 

Sub New

constructor (String, String, ParameterDirection)

 

constructor(name: String; dataTypeName: String; direction: ParameterDirection)

 

DynamicRequestParameter(String name, String dataTypeName, ParameterDirection direction)

 

Sub New (name As String, dataTypeName As String, direction As ParameterDirection)

Parameters:

  • name:
  • dataTypeName:
  • direction:

constructor (String, String, ParameterDirection, Object)

 

constructor(name: String; dataTypeName: String; direction: ParameterDirection; value: Object)

 

DynamicRequestParameter(String name, String dataTypeName, ParameterDirection direction, Object value)

 

Sub New (name As String, dataTypeName As String, direction As ParameterDirection, value As Object)

Parameters:

  • name:
  • dataTypeName:
  • direction:
  • value:

Collection

 

property Collection: DynamicRequestParameterCollection read write;

 

DynamicRequestParameterCollection Collection { get; set; }

 

Property Collection As DynamicRequestParameterCollection

DataType

Read-only property that returns the actual System.Type used to represent this parameter. The type depends on the type name assigned to the DataTypeName property and can be changed by assigning the appropriate name to DataTypeName.

Note: If DataType returns null/nil, the assigned DataTypeName is not a valid type or is not a type supported by the Remoting SDK.

 

property DataType: Type read;

 

Type DataType { get; }

 

Property ReadOnly DataType As Type

DataTypeName

Defines the name of the data type used for this parameter. It must be supported by the Remoting SDK and it can either be a simple type or a custom type defined in the RODL of your service.

Note: When using custom types defined in the RODL, the Interface (*_Intf) file defining them must be linked into your project (or into a referenced assembly), as these types need to be available at runtime. If the assigned DataTypeName is not a valid type or not a type supported by Remoting SDK, DataType will return null/nil.

 

property DataTypeName: String read write;

 

String DataTypeName { get; set; }

 

Property DataTypeName As String

Direction

Defines the direction of the parameter. Parameters can either * be passed into the method ("In") * be passed in and back out ("InOut", comparable to C#'s "ref") or * be returned as outgoing parameters ("Out"). Also, one parameter per method can be marked as "Result" to specify the return value of the call.

 

property Direction: ParameterDirection read write;

 

ParameterDirection Direction { get; set; }

 

Property Direction As ParameterDirection

Name

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name As String

StreamingFormat

Returns the streaming format used for the parameter. For some simple types the Remoting SDK provides different streaming formats based on context or contents. For example, Strings can be streamed as WideString (16-bit Unicode), UTF-8 (8-bit with multi-byte characters) or ANSI (8-bit). While all three string formats will be represented as as System.String DataType, they will return a different streaming format.

The returned value depends on the type name assigned to the DataTypeName property, and can be changed by assigning the appropriate name to DataTypeName.

Note: In the .NET code the streaming format can usually be ignored, as all string types will be converted to and from the appropriate Unicode System.String value. For example, a streaming format of WideString indicates that the string will be sent as 16-bit double-byte characters, while a format of Utf8String will cause the string to be converted to/from UTF-8.

 

property StreamingFormat: StreamingFormat read;

 

StreamingFormat StreamingFormat { get; }

 

Property ReadOnly StreamingFormat As StreamingFormat

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String

Value

This property contains the value to be passed into or returned from the method call. Incoming parameters (parameters with a Direction of "In" and "InOut") must be initialized before making a call, and the Value must match the specified DataType.

 

property Value: Object read write;

 

Object Value { get; set; }

 

Property Value As Object

 

Collection

 

property Collection: DynamicRequestParameterCollection read write;

 

DynamicRequestParameterCollection Collection { get; set; }

 

Property Collection As DynamicRequestParameterCollection

DataType

Read-only property that returns the actual System.Type used to represent this parameter. The type depends on the type name assigned to the DataTypeName property and can be changed by assigning the appropriate name to DataTypeName.

Note: If DataType returns null/nil, the assigned DataTypeName is not a valid type or is not a type supported by the Remoting SDK.

 

property DataType: Type read;

 

Type DataType { get; }

 

Property ReadOnly DataType As Type

DataTypeName

Defines the name of the data type used for this parameter. It must be supported by the Remoting SDK and it can either be a simple type or a custom type defined in the RODL of your service.

Note: When using custom types defined in the RODL, the Interface (*_Intf) file defining them must be linked into your project (or into a referenced assembly), as these types need to be available at runtime. If the assigned DataTypeName is not a valid type or not a type supported by Remoting SDK, DataType will return null/nil.

 

property DataTypeName: String read write;

 

String DataTypeName { get; set; }

 

Property DataTypeName As String

Direction

Defines the direction of the parameter. Parameters can either * be passed into the method ("In") * be passed in and back out ("InOut", comparable to C#'s "ref") or * be returned as outgoing parameters ("Out"). Also, one parameter per method can be marked as "Result" to specify the return value of the call.

 

property Direction: ParameterDirection read write;

 

ParameterDirection Direction { get; set; }

 

Property Direction As ParameterDirection

Name

 

property Name: String read write;

 

String Name { get; set; }

 

Property Name As String

StreamingFormat

Returns the streaming format used for the parameter. For some simple types the Remoting SDK provides different streaming formats based on context or contents. For example, Strings can be streamed as WideString (16-bit Unicode), UTF-8 (8-bit with multi-byte characters) or ANSI (8-bit). While all three string formats will be represented as as System.String DataType, they will return a different streaming format.

The returned value depends on the type name assigned to the DataTypeName property, and can be changed by assigning the appropriate name to DataTypeName.

Note: In the .NET code the streaming format can usually be ignored, as all string types will be converted to and from the appropriate Unicode System.String value. For example, a streaming format of WideString indicates that the string will be sent as 16-bit double-byte characters, while a format of Utf8String will cause the string to be converted to/from UTF-8.

 

property StreamingFormat: StreamingFormat read;

 

StreamingFormat StreamingFormat { get; }

 

Property ReadOnly StreamingFormat As StreamingFormat

Value

This property contains the value to be passed into or returned from the method call. Incoming parameters (parameters with a Direction of "In" and "InOut") must be initialized before making a call, and the Value must match the specified DataType.

 

property Value: Object read write;

 

Object Value { get; set; }

 

Property Value As Object

 

constructor

 

constructor

 

DynamicRequestParameter()

 

Sub New

constructor (String, String, ParameterDirection)

 

constructor(name: String; dataTypeName: String; direction: ParameterDirection)

 

DynamicRequestParameter(String name, String dataTypeName, ParameterDirection direction)

 

Sub New (name As String, dataTypeName As String, direction As ParameterDirection)

Parameters:

  • name:
  • dataTypeName:
  • direction:

constructor (String, String, ParameterDirection, Object)

 

constructor(name: String; dataTypeName: String; direction: ParameterDirection; value: Object)

 

DynamicRequestParameter(String name, String dataTypeName, ParameterDirection direction, Object value)

 

Sub New (name As String, dataTypeName As String, direction As ParameterDirection, value As Object)

Parameters:

  • name:
  • dataTypeName:
  • direction:
  • value:

ToString

 

method ToString: String

 

String ToString()

 

Function ToString As String

See Also