RecordSetMetaData Object

Use the AppConnRecordSetMetaData object to manage recordset metadata.

Click a method to see more information on its use, syntax, and parameters:

Description Property

Used to get a description of a recordset within the Verastream model.

Syntax

object.Description

Part Description
object An operation metadata object
Description A description of the recordset

Remarks

Use the Description property to get the description of a recordset in the Verastream model.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)
MsgBox ("Recordset description is " & objMetaData.Description)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set objMetaData = Nothing

FieldNames Property

Used to get a list of the fields of the recordset.

Syntax

Set FieldNames = object.FieldNames

Part Description
object An operation metadata object
FieldName A list of field names for a recordset

Remarks

Use the FieldNames property to get a list of field names for a recordset.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

Set appStringList = objMetaData.FieldNames
For I = 1 To appStringList.Count
    MsgBox ("Field name: " & appStringList(I))
Next
appStringList.Clear

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set objMetaData = Nothing
Set appStringList = Nothing

GetScrollOperation Method

Used to get the scroll operation for the given scroll movements of the recordset.

Syntax

OperationName = object.GetScrollOperation(ScrollMovement)

Part Description
object A recordset metadata object
ScrollMovement A scroll movement
OperationName The name of the scroll operation

Remarks

Use the GetScrollOperation method to get the name of a scroll operation for a scroll movement of a recordset.

The enumeration values for AppConnScrollMovement are defined in the Type Library.

Scroll Movement Names
ScrollHome
ScrollEnd
ScrollLineUp
ScrollLineDown
ScrollPageUp
ScrollPageDown

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData
Dim scrollMovements As Variant
Dim count, scrollMovement As Integer

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

scrollMovements = objMetaData.scrollMovements
count = UBound(objMetaData.scrollMovements) - LBound(objMetaData.scrollMovements)
For I = 0 To count
    Select Case objMetaData.scrollMovements(I)
        Case Is = AppConnScrollMovement.ScrollPageDown
            MsgBox ("Page Down operation: " & objMetaData.GetScrollOperation(ScrollPageDown))
        Case Is = AppConnScrollMovement.ScrollPageUp
            MsgBox ("Page Up operation: " & objMetaData.GetScrollOperation(ScrollPageUp))
        Case Is = AppConnScrollMovement.ScrollEnd
            MsgBox ("End operation: " & objMetaData.GetScrollOperation(ScrollEnd))
        Case Is = AppConnScrollMovement.ScrollHome
            MsgBox ("Home operation: " & objMetaData.GetScrollOperation(ScrollHome))
        Case Is = AppConnScrollMovement.ScrollLineDown
            MsgBox ("Line Down operation: " & objMetaData.GetScrollOperation(ScrollLineDown))
        Case Is = AppConnScrollMovement.ScrollLineUp
            MsgBox ("Line Up operation: objMetaData.GetScrollOperation(ScrollLineUp)")
    End Select
Next

Set objMetaData = Nothing
Verastream_Session.Disconnect
Set Verastream_Session = Nothing

MetaDataType

Used to get the metadata type of the recordset.

Syntax

object.MetaDataType

Part Description
object An operation metadata object
MetaDataType The metadata type for the recordset

Remarks

Use the MetaDataType property to get the metadata type for the recordset. The enumeration values for AppConnScrollMovement are defined in the Type Library.

Return Value Definition
0
1

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)
MsgBox ("Recordset type is " & objMetaData.MetaDataType)

Verastream_Session.Disconnect
Set Verastream_Session = Nothing
Set objMetaData = Nothing

Name Property

Used to get the name of the recordset.

Syntax

object.Name

Part Description
object An operation metadata object
Name The name of the recordset

Remarks

Use the Name property to get the name of the recordset.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

MsgBox ("Recordset name is " & objMetaData.Name)
Set objMetaData = Nothing
Verastream_Session.Disconnect
Set Verastream_Session = Nothing

ScrollMovementArray Property

Used to get an array of scroll movements of the recordset.

Syntax

Movements = object.ScrollMovementArray

Part Description
object An operation metadata object
Movements A list of scroll movements for a recordset

Remarks

Identical in functionality to the ScrollMovements property but modified to work in VBScript programs.

ScrollMovements Property

Used to get an array of scroll movements of the recordset.

Syntax

Movements = object.ScrollMovements

Part Description
object An operation metadata object
Movements A list of scroll movements for a recordset

Remarks

Use the ScrollMovements property to get a list of scroll movements for a recordset. The enumeration values for AppConnScrollMovement are defined in the Type Library.

Scroll Movement Names
ScrollHome
ScrollEnd
ScrollLineUp
ScrollLineDown
ScrollPageUp
ScrollPageDown

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData
Dim scrollMovements As Variant
Dim count, scrollMovement As Integer

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

scrollMovements = objMetaData.scrollMovements
count = UBound(objMetaData.scrollMovements) - LBound(objMetaData.scrollMovements)
For I = 0 To count
    Select Case objMetaData.scrollMovements(I)
        Case Is = AppConnScrollMovement.ScrollPageDown
            MsgBox ("Page Down operation: " & objMetaData.GetScrollOperation(ScrollPageDown))
        Case Is = AppConnScrollMovement.ScrollPageUp
            MsgBox ("Page Up operation: " & objMetaData.GetScrollOperation(ScrollPageUp))
        Case Is = AppConnScrollMovement.ScrollEnd
            MsgBox ("End operation: " & objMetaData.GetScrollOperation(ScrollEnd))
        Case Is = AppConnScrollMovement.ScrollHome
            MsgBox ("Home operation: " & objMetaData.GetScrollOperation(ScrollHome))
        Case Is = AppConnScrollMovement.ScrollLineDown
            MsgBox ("Line Down operation: " & objMetaData.GetScrollOperation(ScrollLineDown))
        Case Is = AppConnScrollMovement.ScrollLineUp
            MsgBox ("Line Up operation: objMetaData.GetScrollOperation(ScrollLineUp)")
    End Select
Next

Set objMetaData = Nothing
Verastream_Session.Disconnect
Set Verastream_Session = Nothing

SupportsDirectInserts Property

Used to get the supports direct inserts flag of the recordset.

Syntax

object.SupportsDirectInserts

Part Description
object A recordset metadata object

Remarks

Use the SupportsDirectInserts property to get the supports direct inserts flag for a recordset.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

MsgBox ("Recordset name is " & objMetaData.Name)
MsgBox ("Recordset description is " & objMetaData.Description)
MsgBox ("Recordset type is " & objMetaData.MetaDataType)
MsgBox ("Recordset SupportsDirectInserts is " & objMetaData.SupportsDirectInserts)

Set appStringList = objMetaData.FieldNames
For I = 1 To appStringList.Count
    MsgBox ("Field name: " & appStringList(I))
Next
appStringList.Clear

Set objMetaData = Nothing
Verastream_Session.Disconnect
Set Verastream_Session = Nothing

SupportsSelect Property

Used to get the supports select flag of the recordset.

Syntax

object.SupportsSelect

Part Description
object A recordset metadata object

Remarks

Use the SupportsSelect property to get the supports select flag for a recordset.

Example

Dim Verastream_Session As AppConnModel
Dim strModelName, strServerName As String
Dim strEntityName, strRecordsetName, strScrollOper As String
Dim objMetaData As RecordSetMetaData

strModelName = "CCSDemo"
strServerName = "localhost"
Set Verastream_Session = New AppConnModel
Verastream_Session.ConnectToModel strServerName, strModelName

strEntityName = "AcctTransactions"
strRecordsetName = "AcctTransData"

Set objMetaData = Verastream_Session.GetRecordSetMetaData(strEntityName, strRecordsetName)

MsgBox ("Recordset name is " & objMetaData.Name)
MsgBox ("Recordset description is " & objMetaData.Description)
MsgBox ("Recordset type is " & objMetaData.MetaDataType)
MsgBox ("Recordset SupportsSelect is " & objMetaData.SupportsSelect)

Set appStringList = objMetaData.FieldNames
For I = 1 To appStringList.Count
    MsgBox ("Field name: " & appStringList(I))
Next
appStringList.Clear

Set objMetaData = Nothing
Verastream_Session.Disconnect
Set Verastream_Session = Nothing