NamedExpressions

Functions
StatusInt	mdlNamedExpression_EvaluateAsCriteria (bool *result, WCharCP expressionName, WCharCP dgnlibName)
	Evaluates that specified named expression and returns the resultant boolean value. More...
StatusInt	mdlNamedExpression_EvaluateAsString (WStringR resultString, WCharCP expressionName, WCharCP dgnlibName)
	Evaluates that specified named expression and returns the resultant string value. More...
StatusInt	mdlNamedExpression_EvaluateAsInt (int *result, WCharCP expressionName, WCharCP dgnlibName, int defaultValue)
	Evaluates that specified named expression and returns the resultant int value. More...
StatusInt	mdlNamedExpression_EvaluateAsMenuMarkType (MenuMarkType *result, WCharCP expressionName, WCharCP dgnlibName, MenuMarkType defaultValue)
	Evaluates that specified named expression and returns the resultant MenuMarkType value. More...
StatusInt	mdlNamedExpression_ExpandExpressionsInString (WStringR resultString, WCharCP stringToProcess, WCharCP leftDelimeter, WCharCP rightDelimeter)
	Expand any embedded named expressions and/or in-line expressions in the input string. More...
StatusInt	mdlNamedExpression_GatherAvailableExpressions (bvector< DgnPlatform::StoredExpressionEntry > &availableExpressions, WCharCP keywordFilter)
	Gather Name and Label from all available named expressions. More...

Detailed Description

Function Documentation

StatusInt mdlNamedExpression_EvaluateAsCriteria	(	bool *	result,
		WCharCP	expressionName,
		WCharCP	dgnlibName
	)

Evaluates that specified named expression and returns the resultant boolean value.

Named Expressions

Name Expression are string expressions stored in dgnlibs. Name Expressions are commonly used to define criteria for displaying tools, task, and menu items.

Parameters

[out]	result	boolean result of expression.
[in]	expressionName	name of expression to evaluate.
[in]	dgnlibName	name of dgnlib that contains the expression to evaluate.

Returns

SUCCESS if named expression could be loaded and evaluated.

Remarks

Required Library: mdlbltin.lib

StatusInt mdlNamedExpression_EvaluateAsInt	(	int *	result,
		WCharCP	expressionName,
		WCharCP	dgnlibName,
		int	defaultValue
	)

Evaluates that specified named expression and returns the resultant int value.

Parameters

[out]	result	int result of expression.
[in]	expressionName	name of expression to evaluate.
[in]	dgnlibName	name of dgnlib that contains the expression to evaluate.
[in]	defaultValue	default value is expression can not be found.

Returns

SUCCESS.

Remarks

Required Library: mdlbltin.lib

StatusInt mdlNamedExpression_EvaluateAsMenuMarkType	(	MenuMarkType *	result,
		WCharCP	expressionName,
		WCharCP	dgnlibName,
		MenuMarkType	defaultValue
	)

Evaluates that specified named expression and returns the resultant MenuMarkType value.

Parameters

[out]	result	MenuMarkType result of expression.
[in]	expressionName	name of expression to evaluate.
[in]	dgnlibName	name of dgnlib that contains the expression to evaluate.
[in]	defaultValue	default value is expression can not be found.

Returns

SUCCESS if named expression could be evaluated as a MenuMarkType.

Remarks

Required Library: mdlbltin.lib

StatusInt mdlNamedExpression_EvaluateAsString	(	WStringR	resultString,
		WCharCP	expressionName,
		WCharCP	dgnlibName
	)

Evaluates that specified named expression and returns the resultant string value.

Parameters

[out]	resultString	boolean result of expression.
[in]	expressionName	name of expression to evaluate.
[in]	dgnlibName	name of dgnlib that contains the expression to evaluate.

Returns

SUCCESS if named expression could be loaded and evaluated.

Remarks

Required Library: mdlbltin.lib

StatusInt mdlNamedExpression_ExpandExpressionsInString	(	WStringR	resultString,
		WCharCP	stringToProcess,
		WCharCP	leftDelimeter,
		WCharCP	rightDelimeter
	)

Expand any embedded named expressions and/or in-line expressions in the input string.

The embedded expressions are in the format {{expressionName}} or {{[symbolset1,symbolsetn]expression}}.

Parameters

[out]	resultString	boolean result of expression.
[in]	stringToProcess	name of expression to evaluate.
[in]	leftDelimeter	not used.
[in]	rightDelimeter	not used.

Returns

SUCCESS if named expression could be expanded.

Remarks

Required Library: mdlbltin.lib

StatusInt mdlNamedExpression_GatherAvailableExpressions	(	bvector< DgnPlatform::StoredExpressionEntry > &	availableExpressions,
		WCharCP	keywordFilter
	)

Gather Name and Label from all available named expressions.

Parameters

[in]	availableExpressions	vector of StoredExpressionEntry objects that contain name and display label of expression.
[in]	keywordFilter	keyword to filter returned expression, if NULL all expression names are returned.

Returns

SUCCESS.

Remarks

Required Library: mdlbltin.lib