Interface IProcedureMetaData
The methods and properties in the ProcedureMetaData class manage procedure metadata.
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IProcedureMetaData : IMetaDataRemarks
The methods and properties in the ProcedureMetaData class manage procedure metadata.
Properties
FilterColumns
Gets a list of the filter columns for a procedure.
Declaration
IList<string> FilterColumns { get; }Property Value
| Type | Description |
|---|---|
| IList<string> | This property returns a list of the filter columns for a procedure |
Remarks
Gets a list of the filter columns for a procedure.
InputColumns
Gets a list of the input columns for a procedure.
Declaration
IList<string> InputColumns { get; }Property Value
| Type | Description |
|---|---|
| IList<string> | This property returns a list of the input columns for a procedure |
Remarks
Gets a list of the input columns for a procedure.
OutputColumns
Gets a list of the output columns for a procedure.
Declaration
IList<string> OutputColumns { get; }Property Value
| Type | Description |
|---|---|
| IList<string> | This property returns a list of the output columns for a procedure |
Remarks
Gets a list of the output columns for a procedure.
ProcedureType
Gets the type for a procedure.
Declaration
ProcedureType ProcedureType { get; }Property Value
| Type | Description |
|---|---|
| ProcedureType | The value returned is a member of the ProcedureType enumeration. |
Remarks
The value returned is a member of the ProcedureType enumeration.
UseForSQL
Gets whether this procedure is used for SQL processing.
Declaration
bool UseForSQL { get; }Property Value
| Type | Description |
|---|---|
| bool | This method returns a bool indicating whether this procedure is used for SQL processing. |
Remarks
Gets whether this procedure is used for SQL processing.
Methods
IsRequiredFilter(string)
Determines whether column is a required filter for a procedure.
Declaration
bool IsRequiredFilter(string colName)Parameters
| Type | Name | Description |
|---|---|---|
| string | colName | Specifies a column. |
Returns
| Type | Description |
|---|---|
| bool | This method returns a boolean indicating whether the column is a required filter for a procedure. |
Remarks
Determines whether column is a required filter for a procedure.
IsRequiredInput(string)
Determines whether a column is a required input for a procedure.
Declaration
bool IsRequiredInput(string colName)Parameters
| Type | Name | Description |
|---|---|---|
| string | colName | Specifies a column. |
Returns
| Type | Description |
|---|---|
| bool | This method returns a boolean indicating whether the column is a required input for a procedure. |
Remarks
Determines whether a column is a required input for a procedure.
ToString()
Generates a string object that represents the current values of this IProcedureMetaData object.
Declaration
string ToString()Returns
| Type | Description |
|---|---|
| string | the string representation of this object |