Show / Hide Table of Contents

Class TableInfo

Table Info Handle wrapper to access table information.

An instance of this class allows to get table's name, the number of fields in the primary table, the number of keys, a table's key field actual position, the field name for a field postion, the position of a fields name, a field's type, a field's type name, the enum's field value from the enum's ordinal, the enum's ordinal from the enum's value, and a list of tits indexes

It is possible to create an instance of the object either from a Table Table object or by its name.

Inheritance
System.Object
TableInfo
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: lxapi
Assembly: lxapi.dll
Syntax
public class TableInfo

Fields

connection

Connection which the object belongs to.

Declaration
public readonly Connection connection
Field Value
Type Description
Connection

kvMTbl

Table Info Handle

Declaration
public readonly IntPtr kvMTbl
Field Value
Type Description
System.IntPtr

table

Info's table

Declaration
public readonly Table table
Field Value
Type Description
Table

Methods

enumOrd(Int32, String)

Get enum ordinal from enum string

Declaration
public int enumOrd(int fno, string enumValue)
Parameters
Type Name Description
System.Int32 fno

enum column position

System.String enumValue

enum string value

Returns
Type Description
System.Int32

enum ordinal value

enumString(Int32, Int32)

Get enum string from enum ordinal

Declaration
public string enumString(int fno, int ord)
Parameters
Type Name Description
System.Int32 fno

enum column position

System.Int32 ord

enum ordinal value

Returns
Type Description
System.String

enum string value

fieldName(Int32)

Get field name of column

Declaration
public string fieldName(int fno)
Parameters
Type Name Description
System.Int32 fno

column position

Returns
Type Description
System.String

field name

fieldType(Int32)

Get field type of column

Declaration
public LxTypes fieldType(int fno)
Parameters
Type Name Description
System.Int32 fno

column position

Returns
Type Description
LxTypes

field type

Finalize()

Declaration
protected void Finalize()

indexes()

Table's indexes

Declaration
public List<string> indexes()
Returns
Type Description
System.Collections.Generic.List<System.String>

indexInfo(String)

Retieve Index Info for index iname

Declaration
public IndexInfo indexInfo(string iname)
Parameters
Type Name Description
System.String iname

index name

Returns
Type Description
IndexInfo

Index info

keyFieldPosition(Int32)

Get table's column for the key column

Declaration
public int keyFieldPosition(int kno)
Parameters
Type Name Description
System.Int32 kno

key field position

Returns
Type Description
System.Int32

name()

table name

Declaration
public string name()
Returns
Type Description
System.String

numOfFields()

Number of fields

Declaration
public int numOfFields()
Returns
Type Description
System.Int32

numOfKeys()

Number of columns that belongs to the key

Declaration
public int numOfKeys()
Returns
Type Description
System.Int32
Back to top Generated by DocFX