ProcedureMetaData Object

Use the ProcedureMetaData object to manage procedure metadata.

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

FilterColumns Property

Used to get an AppConnStringList of the filter columns of a procedure.

Syntax

Set FilterColumns = object.FilterColumns

Part Description
object A ProcedureMetaData object
FilterColumns An AppConnStringList of filter columns for a procedure

Remarks

Use the FilterColumns property to get an AppConnStringList of filter columns for a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim ProcStringList As AppConnStringList
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
   "GetTransactions")

Set ProcStringList = ProcMetaData.FilterColumns
For I = 1 To ProcStringList.Count
    MsgBox ("Filter column " & I & " is " & ProcStringList(I))

Next
ProcStringList.Clear

Verastream_Session.Disconnect
Set ProcStringList = Nothing
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

InputColumns Property

Used to get an AppConnStringList of the input columns of a procedure.

Syntax

Set InputColumns = object.InputColumns

Part Description
object A ProcedureMetaData object
InputColumns An AppConnStringList of input columns for a procedure

Remarks

Use the InputColumns property to get an AppConnStringList of input columns for a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim ProcStringList As AppConnStringList
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
   "GetTransactions")

Set ProcStringList = ProcMetaData.InputColumns
For I = 1 To ProcStringList.Count
    MsgBox ("Input column " & I & " is " & ProcStringList(I))
    MsgBox ("Is " & ProcStringList(I) & " required? " & _
        ProcMetaData.IsRequiredInput(ProcStringList(I)))
Next
ProcStringList.Clear

Verastream_Session.Disconnect
Set ProcStringList = Nothing
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

IsRequiredFilter Method

Used to determine if a column is required filter for a procedure.

Syntax

IsRequiredFilter = object.IsRequiredFilter(ColumnName)

Part Description
object A ProcedureMetaData object
ColumnName The string name of a column
IsRequiredFilter Boolean indicator whether the column is required for filter or not

Remarks

Use the IsRequiredFilter method to determine if a column is required filter for a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim ProcStringList As AppConnStringList
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

Set ProcStringList = ProcMetaData.FilterColumns
For I = 1 To ProcStringList.Count
    MsgBox ("Filter column " & I & " is " & ProcStringList(I))
    MsgBox ("Is " & ProcStringList(I) & " required? " & _
        ProcMetaData.IsRequiredFilter(ProcStringList(I)))
Next
ProcStringList.Clear

Verastream_Session.Disconnect
Set ProcStringList = Nothing
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

IsRequiredInput Method

Used to determine if a column is required input for a procedure.

Syntax

IsRequiredInput = object.IsRequiredInput(ColumnName)

Part Description
object A ProcedureMetaData object
ColumnName The string name of a column
IsRequiredInput Boolean indicator whether the column is required for input or not

Remarks

Use the IsRequiredInput method to determine if a column is required input for a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim ProcStringList As AppConnStringList
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

Set ProcStringList = ProcMetaData.InputColumns
For I = 1 To ProcStringList.Count
    MsgBox ("Input column " & I & " is " & ProcStringList(I))
    MsgBox ("Is " & ProcStringList(I) & " required? " & _
        ProcMetaData.IsRequiredInput(ProcStringList(I)))
Next
ProcStringList.Clear

Verastream_Session.Disconnect
Set ProcStringList = Nothing
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

MetaDataType Property

Used to get the type of metadata for the procedure.

Syntax

object.MetaDataType

Part Description
object A ProcedureMetaData object

Remarks

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

Metadata Types
AttributeMeta
OperationMeta
RecordSetMeta
FieldMeta
VariableMeta
TableMeta
ColumnMeta
ProcedureMeta

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

MsgBox ("Metadata type is " & ProcMetaData.MetaDataType)

Verastream_Session.Disconnect
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

OutputColumns Property

Used to get an AppConnStringList of the output columns of a procedure.

Syntax

Set OutputColumns = object.OutputColumns

Part Description
object A ProcedureMetaData object
OutputColumns An AppConnStringList of output columns for a procedure

Remarks

Use the OutputColumns property to get an AppConnStringList of output columns for a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim ProcStringList As AppConnStringList
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

Set ProcStringList = ProcMetaData.OutputColumns
For I = 1 To ProcStringList.Count
    MsgBox ("Output column " & I & " is " & ProcStringList(I))
Next
ProcStringList.Clear

Verastream_Session.Disconnect
Set ProcStringList = Nothing
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

ProcedureType Property

Used to get the type of a procedure.

Syntax

object.ProcedureType

Part Description
object A ProcedureMetaData object

Remarks

Use the Procedure property to get the type of a procedure. The enumeration values for AppConnProcedureType are defined in the Type Library.

Return Values Procedure Types
0 DeleteProcedure
1 UpdateProcedure
2 SelectProcedure
3 InsertProcedure

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

MsgBox ("Procedure type is " & ProcMetaData.ProcedureType)

Verastream_Session.Disconnect
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

UsedForSQL Property

Used to get the used for SQL flag of a procedure.

Syntax

object.UsedForSQL

Part Description
object A ProcedureMetaData object

Remarks

Use the UsedForSQL property to get the used for SQL flag of a procedure.

Example

Dim Verastream_Session As AppConnSessionEx
Dim ProcMetaData As ProcedureMetaData
Dim strModelName, strServerName As String

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

Set ProcMetaData = Verastream_Session.GetProcedureMetaData("Transactions", _
		"GetTransactions")

MsgBox ("Is the procedure used for SQL?  " & ProcMetaData.UsedForSQL)

Verastream_Session.Disconnect
Set ProcMetaData = Nothing
Set Verastream_Session = Nothing

© 1999-2007 Attachmate Corporation. All rights reserved. Terms of Use.