DynamicRequestParameter Class
From RemObjects Software
This is a Data Abstract Architecture entry
Feel free to add your notes to this topic below.
Overview (.NET)
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 RemObjects.SDK. It is contained in DataAbstract.dll.
Namespace
Declaration (C#)
public class DynamicRequestParameter : NamedObject;
Hierarchy
- RemObjects.Common.Collections.NamedObject
- RemObjects.SDK.DynamicRequestParameter
Properties
| | | |
|---|---|---|
| Collection | DynamicRequestParameterCollection | |
| DataType | Type | 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 RemObjects SDK. |
| DataTypeName | String | Defines the name of the data type used for this parameter.
It must be supported by the RemObjects 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 RemObjects SDK, DataType will return null/nil. |
| Direction | ParameterDirection | Defines the direction of the parameter.
Parameters can either
Also, one parameter per method can be marked as "Result" to specify the return value of the call. |
| StreamingFormat | StreamingFormat | Returns the streaming format used for the parameter.
For some simple types the RemObjects 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. |
| Value | Object | 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. |
Methods
| | |
|---|---|
| DynamicRequestParameter | Default constructor for DynamicRequestParameter. |
See Also
Product: RemObjects Data Abstract
Current version: Data Abstract 'Vinci' (5.0)
Lists — Glossary — Features — How To — Drivers — Components — Tools — Samples — Articles — Architecture — Issues
