Tables

Functions
BitMaskCP	mdlLevelTable_getDisplayMask (DgnModelRefP modelRefIn)
	Get the display mask for level-table. More...
BitMaskCP	mdlLevelTable_getPlotMask (DgnModelRefP modelRefIn)
	Get the plot mask for level-table. More...
BitMaskCP	mdlLevelTable_getExternalMask (DgnModelRefP modelRefIn)
	Get the external mask for level-table. More...
BitMaskCP	mdlLevelTable_getHiddenMask (DgnModelRefP modelRefIn)
	Get the hidden mask for level-table. More...
BitMaskCP	mdlLevelTable_getReadOnlyMask (DgnModelRefP modelRefIn)
	Get the read-only mask for level-table. More...
BitMaskCP	mdlLevelTable_getFrozenMask (DgnModelRefP modelRefIn, LevelFrozenType frozenTypeIn)
	Get the frozen mask for level-table. More...
BitMaskCP	mdlLevelTable_getDisplayFrozenMask (DgnModelRefP modelRefIn)
	Get the effective combined display + frozen mask for level-table. More...
BitMaskCP	mdlLevelTable_getUsageMask (DgnModelRefP modelRefIn)
	Get the level usage mask for level-table. More...
StatusInt	mdlLevelTable_setDisplayMask (DgnModelRefP modelRefIn, BitMaskCP displayMaskIn, bool updateViewIn)
	Set the display flag for all levels of level-table. More...
StatusInt	mdlLevelTable_setFrozenMask (DgnModelRefP modelRefIn, BitMaskCP frozenMaskIn, LevelFrozenType frozenTypeIn, bool updateViewIn)
	Set the frozen flag for all levels of level-table. More...
int	mdlTable_scanModel (DgnModelRefP scanModelRefIn, UInt tableLevelIn, PFScanElemDscrCallback pCallbackFunctionIn, CallbackArgP pCallbackArgumentIn)
	Scan the dictionary model of the file containing the specified model for table & its table-entry elements. More...
int	mdlTable_scanThisModel (DgnModelRefP scanModelRefIn, UInt tableLevelIn, PFScanElemDscrCallback pElemDescrCallbackFunctionIn, CallbackArgP pCallbackArgumentIn)
	Scan specified model for table & its table-entry elements. More...
int	mdlTable_scanModelByElementRef (DgnModelRefP scanModelRefIn, UInt tableLevelIn, PFScanElemRefCallback pCallbackFunctionIn, CallbackArgP pCallbackArgumentIn)
	Scan specified model for table & its table-entry elements. More...
int	mdlTable_scanCache (DgnModelP scanCacheIn, UInt tableLevelIn, PFScanElemDscrCallback pCallbackFunctionIn, CallbackArgP pCallbackArgumentIn)
	Scan specified cache looking for table & its table-entry elements. More...
int	mdlTable_scanCacheByElementRef (DgnModelP scanCacheIn, UInt tableLevelIn, PFScanElemRefCallback pCallbackFunctionIn, CallbackArgP pCallbackArgumentIn)
	Scan specified cache looking for table & its table-entry elements. More...

Detailed Description

Function Documentation

BitMaskCP mdlLevelTable_getDisplayFrozenMask

(

DgnModelRefP

modelRefIn

)

Get the effective combined display + frozen mask for level-table.

Returns in a bit-mask form a represention of whether is level is displayed or not frozen (each bit is represented as: display-bit & inverse frozen-bit).

Remarks

The bit-mask is 1 based. For example to get the display-frozen flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pDisplayFrozenBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The display + frozen mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevelTable_getFrozenMaskC usmthmdlLevelTable_getDisplayMaskC

BitMaskCP mdlLevelTable_getDisplayMask

(

DgnModelRefP

modelRefIn

)

Get the display mask for level-table.

Returns a bit-mask that represents which level's display is turned on or off.

Remarks

The bit-mask is 1 based. For example to get the display flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pDisplayBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The display mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevel_setDisplayMaskC usmthmdlLevelTable_getDisplayFrozenMaskC usmthmdlLevel_getDisplayC usmthmdlLevel_setDisplayC

BitMaskCP mdlLevelTable_getExternalMask

(

DgnModelRefP

modelRefIn

)

Get the external mask for level-table.

Returns a bit-mask that represents whether a level is external or not. A level is external, if it is associated with a library level.

Remarks

The bit-mask is 1 based. For example to get the external flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pExternalBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The external mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevel_getExternalC usmthmdlLevel_isExternalC usmthmdlLevel_getLibraryRefC

BitMaskCP mdlLevelTable_getFrozenMask	(	DgnModelRefP	modelRefIn,
		LevelFrozenType	frozenTypeIn
	)

Get the frozen mask for level-table.

Returns a bit-mask that represents whether a level is frozen or not.

Remarks

The bit-mask is 1 based. For example to get the frozen flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pFrozenBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]	modelRefIn	model-ref of level-table
[in]	frozenTypeIn	one of LEVEL_FROZEN_TYPE_... (defined in leveltable.h)

Returns

The frozen mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevelTable_setFrozenMaskC usmthmdlLevelTable_getDisplayFrozenMaskC usmthmdlLevel_getFrozenC usmthmdlLevel_isFrozenC usmthmdlLevel_setFrozenC

BitMaskCP mdlLevelTable_getHiddenMask

(

DgnModelRefP

modelRefIn

)

Get the hidden mask for level-table.

Returns a bit-mask that represents whether a level is hidden or not. If a level is hidden, then it is not displayed in the level manager.

Remarks

The bit-mask is 1 based. For example to get the hidden flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pHiddenBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The hidden mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevel_getHiddenC usmthmdlLevel_isHiddenC usmthmdlLevel_setHiddenC

BitMaskCP mdlLevelTable_getPlotMask

(

DgnModelRefP

modelRefIn

)

Get the plot mask for level-table.

Returns a bit-mask that represents which level's plot is turned on or off.

Remarks

The bit-mask is 1 based. For example to get the plot flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pPlotBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The plot mask as a BitMask. Returns NULL if modelRefIn is invalid " "

See also

usmthmdlLevel_getPlotC usmthmdlLevel_setPlotC

BitMaskCP mdlLevelTable_getReadOnlyMask

(

DgnModelRefP

modelRefIn

)

Get the read-only mask for level-table.

Returns a bit-mask that represents whether a level is read-only or not. If a level is readonly, then its attributes cannot be changed.

Remarks

The bit-mask is 1 based. For example to get the read-only flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pReadOnlyBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The read-only mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevel_getReadOnlyC usmthmdlLevel_isReadOnlyC usmthmdlLevel_setReadOnlyC

BitMaskCP mdlLevelTable_getUsageMask

(

DgnModelRefP

modelRefIn

)

Get the level usage mask for level-table.

Returns a bit-mask that represents whether a level is used or not.

Remarks

The bit-mask is 1 based. For example to get the used flag for a level with the function mdlBitMask_testBit, your call should look like: mdlBitMask_testBit(pUsedBitMask, levelid -1)

Note the "const"ness of the returned bit-mask. It is important not to cast into a non-const bit-mask. This bit-mask should not be changed.

Parameters

[in]

modelRefIn

model-ref of level-table

Returns

The usage mask as a BitMask. Returns NULL if modelRefIn is invalid. " "

See also

usmthmdlLevel_getUsageC usmthmdlLevel_isUsedC

StatusInt mdlLevelTable_setDisplayMask	(	DgnModelRefP	modelRefIn,
		BitMaskCP	displayMaskIn,
		bool	updateViewIn
	)

Set the display flag for all levels of level-table.

Parameters

[in]	modelRefIn	model-ref of level-table
[in]	displayMaskIn	level display mask to set
[in]	updateViewIn	if true, then update the views

Returns

ERROR if the model-ref is invalid or the level-table is READ-ONLY, else SUCCESS " "

See also

usmthmdlLevel_getDisplayMaskC usmthmdlLevel_getDisplayC usmthmdlLevel_setDisplayC

StatusInt mdlLevelTable_setFrozenMask	(	DgnModelRefP	modelRefIn,
		BitMaskCP	frozenMaskIn,
		LevelFrozenType	frozenTypeIn,
		bool	updateViewIn
	)

Set the frozen flag for all levels of level-table.

Parameters

[in]	modelRefIn	model-ref of level-table
[in]	frozenMaskIn	level frozen mask to set
[in]	frozenTypeIn	one of LEVEL_FROZEN_TYPE_... (defined in leveltable.h)
[in]	updateViewIn	if true, then update the views

Returns

ERROR if the model-ref is invalid or the level-table is READ-ONLY, else SUCCESS " "

See also

usmthmdlLevelTable_getFrozenMaskC usmthmdlLevelTable_getDisplayFrozenMaskC usmthmdlLevel_getFrozenC usmthmdlLevel_isFrozenC usmthmdlLevel_setFrozenC

int mdlTable_scanCache	(	DgnModelP	scanCacheIn,
		UInt	tableLevelIn,
		PFScanElemDscrCallback	pCallbackFunctionIn,
		CallbackArgP	pCallbackArgumentIn
	)

Scan specified cache looking for table & its table-entry elements.

Specified call-back function is called when the table or table-entry elements are encountered.

Parameters

[in]	scanCacheIn	cache to scan for table elements
[in]	tableLevelIn	level of table to scan for (0 if tables with all levels are to be scanned)
[in]	pCallbackFunctionIn	call back function to call
[in]	pCallbackArgumentIn	call back argument

Returns

ERROR if the scan cache is not valid

Remarks

Required Library: mdlbltin.lib

int mdlTable_scanCacheByElementRef	(	DgnModelP	scanCacheIn,
		UInt	tableLevelIn,
		PFScanElemRefCallback	pCallbackFunctionIn,
		CallbackArgP	pCallbackArgumentIn
	)

Scan specified cache looking for table & its table-entry elements.

Specified call-back function is called when the table or table-entry elements are encountered.

Parameters

[in]	scanCacheIn	cache to scan for table elements
[in]	tableLevelIn	level of table to scan for (0 if tables with all levels are to be scanned)
[in]	pCallbackFunctionIn	call back function to call
[in]	pCallbackArgumentIn	call back argument

Returns

ERROR if the scan cache is not valid

Remarks

Required Library: mdlbltin.lib

int mdlTable_scanModel	(	DgnModelRefP	scanModelRefIn,
		UInt	tableLevelIn,
		PFScanElemDscrCallback	pCallbackFunctionIn,
		CallbackArgP	pCallbackArgumentIn
	)

Scan the dictionary model of the file containing the specified model for table & its table-entry elements.

Specified call-back function is called when the table or table-entry elements are encountered.

Parameters

[in]	scanModelRefIn	model in which to scan for table elements
[in]	tableLevelIn	level of table to scan for (0 if tables with all levels are to be scanned)
[in]	pCallbackFunctionIn	call back function to call
[in]	pCallbackArgumentIn	call back argument

Returns

ERROR if the scan model is not valid

Remarks

Required Library: mdlbltin.lib

int mdlTable_scanModelByElementRef	(	DgnModelRefP	scanModelRefIn,
		UInt	tableLevelIn,
		PFScanElemRefCallback	pCallbackFunctionIn,
		CallbackArgP	pCallbackArgumentIn
	)

Scan specified model for table & its table-entry elements.

Specified call-back function is called when the table or table-entry elements are encountered.

Parameters

[in]	scanModelRefIn	model in which to scan for table elements
[in]	tableLevelIn	level of table to scan for (0 if tables with all levels are to be scanned)
[in]	pCallbackFunctionIn	call back function to call
[in]	pCallbackArgumentIn	call back argument

Returns

ERROR if the scan model is not valid

Remarks

Required Library: mdlbltin.lib

int mdlTable_scanThisModel	(	DgnModelRefP	scanModelRefIn,
		UInt	tableLevelIn,
		PFScanElemDscrCallback	pElemDescrCallbackFunctionIn,
		CallbackArgP	pCallbackArgumentIn
	)

Scan specified model for table & its table-entry elements.

Specified call-back function is called when the table or table-entry elements are encountered.

Parameters

[in]	scanModelRefIn	model in which to scan for table elements
[in]	tableLevelIn	level of table to scan for (0 if tables with all levels are to be scanned)
[in]	pElemDescrCallbackFunctionIn	call back function to call
[in]	pCallbackArgumentIn	call back argument

Returns

ERROR if the scan model is not valid

Remarks

Required Library: mdlbltin.lib