Platforms to show: All Mac Windows Linux Cross-Platform
SQLParamMBS class
Super class: SQLValueMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | SQL | MBS SQL Plugin | 9.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
see also
https://www.sqlapi.com/ApiDoc/class_s_a_param.html
Subclass of the SQLValueMBS class.
- 11 properties
- property DirType as Integer
- property IsInput as Boolean
- property IsOutput as Boolean
- property Name as string
- property NativeType as Integer
- property Options as Dictionary
- property Precision as Integer
- property Scale as Integer
- property Size as Integer
- property Type as Integer
- property Option(name as string) as string
- 3 methods
- method ReadLongOrLob(toConsumer as SQLDataConsumerMBS, BlockSize as Integer)
- method ReadLongOrLob(toFile as FolderItem)
- method ReadLongOrLob(toStream as Writeable)
- 4 constants
Constants
Constant | Value | Description |
---|---|---|
kParamDirTypeInput | 0 |
One of the parameter direction type constants.
Input parameter. |
kParamDirTypeInputOutput | 1 |
One of the parameter direction type constants.
Input/output parameter. |
kParamDirTypeOutput | 2 |
One of the parameter direction type constants.
Output parameter. |
kParamDirTypeReturn | 3 |
One of the parameter direction type constants.
Returning parameter. |
Super class SQLValueMBS
- property isDefault as boolean
- 52 methods
- method Constructor(DataType as Integer)
- method setAsBlob(data as MemoryBlock)
- method setAsBlob(data as SQLDataProviderMBS, BlockSize as UInt32)
- method setAsBlob(data as SQLStringMBS)
- method setAsBlob(data as string)
- method setAsBlob(file as folderItem)
- method setAsBlob(stream as Readable)
- method setAsBool(value as boolean)
- method setAsBytes(data as MemoryBlock)
- method setAsBytes(data as string)
- method setAsBytes(value as SQLBytesMBS)
- method setAsBytes(value as SQLStringMBS)
- method setAsClob(data as MemoryBlock) Private
- method setAsClob(data as SQLDataProviderMBS, BlockSize as UInt32)
- method setAsClob(file as folderItem)
- method setAsClob(stream as Readable)
- method setAsClob(text as SQLStringMBS)
- method setAsClob(text as string)
- method setAsDate(value as date)
- method setAsDateTime(value as dateTime)
- method setAsDateTime(value as SQLDateTimeMBS)
- method setAsDefault
- method setAsDouble(value as Double)
- method setAsInt32(value as Int32)
- method setAsInt64(value as Int64)
- method setAsInteger(value as Integer)
- method setAsInterval(value as SQLIntervalMBS)
- method setAsLong(value as Int32)
- method setAsLongBinary(data as MemoryBlock)
- method setAsLongBinary(data as SQLDataProviderMBS, BlockSize as UInt32)
- method setAsLongBinary(data as SQLStringMBS)
- method setAsLongBinary(data as string)
- method setAsLongBinary(file as folderItem)
- method setAsLongBinary(stream as Readable)
- method setAsLongChar(data as MemoryBlock) Private
- method setAsLongChar(data as SQLDataProviderMBS, BlockSize as UInt32)
- method setAsLongChar(file as folderItem)
- method setAsLongChar(stream as Readable)
- method setAsLongChar(text as SQLStringMBS)
- method setAsLongChar(text as string)
- method setAsNull
- method setAsNumeric(value as SQLNumericMBS)
- method setAsShort(value as Int16)
- method setAsString(data as MemoryBlock) Private
- method setAsString(value as SQLStringMBS)
- method setAsString(value as string)
- method setAsUInt32(value as UInt32)
- method setAsULong(value as UInt32)
- method setAsUnknown
- method setAsUShort(value as UInt16)
- method setAsValueRead(value as SQLValueReadMBS)
- method setVariant(value as Variant)
Super class SQLValueReadMBS
- 15 properties
- property asBool as boolean
- property asDouble as Double
- property asInt32 as Int32
- property asInt64 as Int64
- property asInteger as Integer
- property asLong as Int32
- property asShort as Int16
- property asStringValue as String
- property asUInt32 as UInt32
- property asULong as UInt32
- property asUShort as UInt16
- property asVariant as Variant
- property DataType as Integer
- property isNull as boolean
- property LongOrLobReaderMode as Integer
- 15 methods
- method asBLob as SQLStringMBS
- method asBLobMemory as MemoryBlock
- method asBLobString as String
- method asBytes as SQLStringMBS
- method asCLob as SQLStringMBS
- method asDate as Date
- method asDateTime as SQLDateTimeMBS
- method asDateTimeValue as DateTime
- method asInterval as SQLIntervalMBS
- method asLongBinary as SQLStringMBS
- method asLongChar as SQLStringMBS
- method asNumeric as SQLNumericMBS
- method asString as SQLStringMBS
- method Constructor(DataType as Integer)
- method Constructor(value as SQLValueReadMBS)
- 22 constants
Constants
Constant | Value | Description |
---|---|---|
kDataTypeInt64 | 6 |
One of the field type constants
Signed 64-bit integer. |
kDataTypeUInt64 | 7 |
One of the field type constants
Unsigned 64-bit integer. |
Data Types
Constant | Value | Description |
---|---|---|
kDataTypeBlob | 16 |
Data type is BLob data (SQLStringMBS). |
kDataTypeBool | 1 |
Data type is a boolean. |
kDataTypeBytes | 13 |
Data type is binary string (SQLStringMBS). |
kDataTypeClob | 17 |
Data type is CLob data (SQLStringMBS). |
kDataTypeCursor | 18 |
Data type is Oracle REF CURSOR (SQLCommand). |
kDataTypeDateTime | 10 |
Data type is SQLDateTime. |
kDataTypeDouble | 8 |
This is a normal double variable. |
kDataTypeInterval | 11 |
Data type is an interval (SQLIntervalMBS). |
kDataTypeLong | 4 |
A 32 bit integer. |
kDataTypeLongBinary | 14 |
Data type is long binary data (SQLStringMBS). |
kDataTypeLongChar | 15 |
Data type is long character data (SQLStringMBS). |
kDataTypeNumeric | 9 |
Data type is SQLNumeric (used internally). |
kDataTypeShort | 2 |
Data type is a 16 bit signed integer. |
kDataTypeSpecificToDBMS | 19 |
Data type is server-specific. |
kDataTypeString | 12 |
Data type is character string (SQLString). |
kDataTypeULong | 5 |
Data type is a 32 bit unsigned integer. |
kDataTypeUnknown | 0 |
Data type is unknown. |
kDataTypeUShort | 3 |
A 16 bit unsigned integer. |
Read Modes
Constant | Value | Description |
---|---|---|
kLongOrLobReaderModeDefault | 0 |
Long or Lob(CLob) data reading mode is default (automatic). |
kLongOrLobReaderModeManual | 1 |
Long or Lob(CLob) data reading mode is manual. |
This class has no sub classes.
Some methods using this class:
- SQLCommandMBS.CreateParam(name as string, ParamType as Integer, DirType as Integer=0) as SQLParamMBS
- SQLCommandMBS.CreateParam(name as string, ParamType as Integer, NativeType as Integer, ParamSize as Integer, ParamPrecision as Integer, ParamScale as Integer, DirType as Integer=0) as SQLParamMBS
- SQLCommandMBS.Param(ID as Integer) as SQLParamMBS
- SQLCommandMBS.Param(name as string) as SQLParamMBS
- SQLCommandMBS.ParamByIndex(index as Integer) as SQLParamMBS
Some examples using this class:
Blog Entries
- MBS SQL Plugin Tips and Tricks
- MBS Xojo Plugins, version 20.3pr3
- MBS Xojo Plugins, version 19.5pr4
- MBS Xojo Plugins, version 19.2pr1
- MBS Xojo Plugins, version 18.4pr10
- MBS Xojo / Real Studio Plugins, version 16.4pr5
- Upcoming Changes for our SQL Plugin
Release notes
- Version 20.3
- Added IsInput and IsOutput properties to SQLParamMBS class.
- Version 19.5
- Fixed bug in SQLDatabaseMBS, SQLParamMBS or SQLFieldMBS where Options may have returned nil.
- Version 19.2
- Changed SQLCommandMBS class to clear SQLFieldMBS and SQLParamMBS objects from it in destructor. If you access them later, you'll get SQLNotInitializedExceptionMBS exception.
- Version 18.4
- Added SQLParamMBS.Options and SQLFieldMBS.Options properties.
The items on this page are in the following plugins: MBS SQL Plugin.
SQLNumericMBS - SQLPositionMBS