Functions
StatusInt	mdlViewGroup_getNameOfActiveGroup (WCharP nameP)
	Returns a copy of the name of the active view group. More...

StatusInt	mdlViewGroup_createFromActive (WCharCP nameP, WCharCP descrP)
	Creates a view group in the cache based on the active one and assigns it the given name and description. More...

StatusInt	mdlViewGroup_applyByName (WCharCP inNameP)
	Finds and applies the view group by name. More...

StatusInt	mdlViewGroup_deleteByName (WCharCP nameP)
	Finds and deletes the view group by name. More...

Detailed Description

Function Documentation

StatusInt mdlViewGroup_applyByName ( WCharCP inNameP )

Finds and applies the view group by name.

Parameters

[in] inNameP name to look up.

Returns: SUCCESS if the operation is completed successfully, otherwise non-SUCCESS. MDLERR_VIEWGROUPNOTFOUND is used specifically to indicate the request was formed correctly but the view group could not be found.

Remarks: The name is stored as mixed case, but the key search is case insensitive.; Required Library: mdlbltin.lib

StatusInt mdlViewGroup_createFromActive	(	WCharCP	nameP,
		WCharCP	descrP
	)

Creates a view group in the cache based on the active one and assigns it the given name and description.

Parameters

[in]	nameP	name for the new view group.
[in]	descrP	description for the new view group.

Returns: SUCCESS if the operation is completed successfully, otherwise non-SUCCESS.

Remarks: The name is stored as mixed case, but the key search is case insensitive, and this function will reject attempts to create view groups with duplicate names.; This operation will create a persisted view group in the active file, unless the file is read-only.; Required Library: mdlbltin.lib

StatusInt mdlViewGroup_deleteByName ( WCharCP nameP )

Finds and deletes the view group by name.

Parameters

[in] nameP name to look up.

Returns: SUCCESS if the operation is completed successfully, otherwise non-SUCCESS. MDLERR_VIEWGROUPNOTFOUND is used specifically to indicate the request was formed correctly but the view group could not be found.

Remarks: The name is stored as mixed case, but the key search is case insensitive.; The active view group may be deleted and in that case the group active prior to the active one will be become the active view group. If no successor remains, a new default view group is created and applied in a default fashion using the active model as the target for the views.; Required Library: mdlbltin.lib

StatusInt mdlViewGroup_getNameOfActiveGroup ( WCharP nameP )

Returns a copy of the name of the active view group.

Parameters

[in] nameP buffer for the name, must be at least MAX_VIEWGROUP_NAME_LENGTH wide chars long.

Returns: SUCCESS if the operation is completed successfully, otherwise non-SUCCESS if the buffer was NULL or there was no active view group.