Click or drag to resize

ICommenceCursorSetRelatedColumn Method

Define column for a connected field. Allows for retrieving other than just the Name field from connections.

Namespace:  Vovin.CmcLibNet.Database
Assembly:  Vovin.CmcLibNet (in Vovin.CmcLibNet.dll) Version: 1.0.7729.42686
Syntax
Copy
bool SetRelatedColumn(
	int nColumn,
	string pConnName,
	string pCatName,
	string pName,
	CmcOptionFlags flags = CmcOptionFlags.Default
)

Parameters

nColumn
Type: SystemInt32
The (0-based) index of the column to set.
pConnName
Type: SystemString
Name of the connection to use in this column.
pCatName
Type: SystemString
Name of the connected Category to use in this column.
pName
Type: SystemString
Name of the field in the connected category to use in this column
flags (Optional)
Type: Vovin.CmcLibNet.DatabaseCmcOptionFlags
Logical OR of following option flags: All - create column set of all fields.

Return Value

Type: Boolean
true on succes, false on error.
Remarks
Setting the CmcOptionFlags.All flag *only* affects direct fields in the cursor. It cannot be used to obtain all fields from the connected category.
Remarks
Related columns must always come after the direct columns. Do not skip or duplicate an index.

Warning: related columns severely impact memory usage and processing time!

Using Columns offers a more convenient way to set related columns.

See Also