Retrieve information about columns within table

Namespace: Wiker.WIDatabase
Assembly: 

Syntax

C#
public bool GetColumnInfo(
	string tableName,
	out Collection<TableColumnItem> columnInfo
)
Visual Basic
Public Function GetColumnInfo ( _
	tableName As String, _
	<OutAttribute> ByRef columnInfo As Collection(Of TableColumnItem) _
) As Boolean
Visual C++
public:
bool GetColumnInfo(
	String^ tableName, 
	[OutAttribute] Collection<TableColumnItem^>^% columnInfo
)

Parameters

tableName
Type: System..::..String
Table name to retrieve information about
columnInfo
Type: System.Collections.ObjectModel..::..Collection<(Of <(<'TableColumnItem>)>)>%
Collection of results

Return Value

bool

Examples

CopyC#
WIDatabase WIDB;
CDatabaseInfo DBInfo;
Collection<TableColumnItem>ColumnInfo;
string DataTypeName, ColumnName;
Type FieldType;

DBInfo = new CDatabaseInfo();
DBInfo.DatabaseType = eDatabaseType.SQL;
DBInfo.Location     = "SqlServer";
DBInfo.DBName       = "TestDatabase";
DBInfo.Username     = "LoginName";
DBInfo.Password     = "LoginPassword";

WIDB = new WIDatabase(DBInfo);

/*----------------------------------------------------------------------------*/

if (!GetColumnInfo("TableX", out ColumnInfo))
   {
   MessageBox.Show(string.Format("Failed To GetColumnInfo\n{0} - {1}", 
                   WIDB.LastError.ToString(), WIDB.LastErrorMessage));
   return(false);
   }

foreach(TableColumnItem Item in ColumnInfo)
   {
   DataTypeName = Item.DataTypeName;
   ColumnName = Item.ColumnName;
   FieldType = Item.FieldType;
   }

WIDB.Close();

See Also