Filter Members

Functions
FilterMemberID	mdlFilterMember_getNext (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Get the next member after given member. More...
FilterMemberID	mdlFilterMember_getPrevious (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Get the previous member before given member. More...
FilterMemberID	mdlFilterMember_getFirst (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
	Get the first member. More...
FilterMemberID	mdlFilterMember_getLast (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn)
	Get the last member. More...
bool	mdlFilterMember_isValid (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Check if a member with specified id is valid. More...
bool	mdlFilterMember_isValidByName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn)
	Check if a member with specified name is valid. More...
StatusInt	mdlFilterMember_create (FilterMemberID *piMemberIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn, UShort memberTypeIn)
	Create a new member for specified filter-table. More...
StatusInt	mdlFilterMember_getType (UShort *pMemberTypeOut, DgnModelRefP pModelRefIn, const WChar *pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Get member type. More...
StatusInt	mdlFilterMember_getName (WChar *pMemberNameOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Get member name. More...
StatusInt	mdlFilterMember_getIdFromName (FilterMemberID *pMemberIdOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, WCharCP pMemberNameIn)
	Get id of member with specified name. More...
StatusInt	mdlFilterMember_delete (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn)
	Delete member. More...
StatusInt	mdlFilterMember_setName (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterMemberID iMemberIdIn, WCharCP pNameIn)
	Set name of filter member. More...
StatusInt	mdlFilterMember_getExpressionSize (int *pStringSizeOut, DgnModelRefP pModelRefIn, const WChar *pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn)
	Get filter-member expression string size. More...
StatusInt	mdlFilterMember_getExpression (WChar *pExpressionStringOut, int stringSizeIn, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn)
	Get filter-member expression string. More...
StatusInt	mdlFilterMember_setExpression (DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn, WCharCP pExpressionStringIn)
	Set filter-member expression string. More...
StatusInt	mdlFilterMember_apply (bool *pPassFlagOut, DgnModelRefP pModelRefIn, WCharCP pFilterTableNameIn, FilterID iFilterIdIn, FilterMemberID iMemberIdIn, FilterValue *pFilterValueIn)
	Apply a filter member's expression string to specified value, to check if the value passes the filter member. More...

Detailed Description

Function Documentation

StatusInt mdlFilterMember_apply	(	bool *	pPassFlagOut,
		DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterID	iFilterIdIn,
		FilterMemberID	iMemberIdIn,
		FilterValue *	pFilterValueIn
	)

Apply a filter member's expression string to specified value, to check if the value passes the filter member.

Parameters

[out]	pPassFlagOut	true if the value passes the filter member, else false
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iFilterIdIn	filter id
[in]	iMemberIdIn	filter member id
[in]	pFilterValueIn	value to apply

Returns

ERROR if the filter table name, filter id or member id is not valid, else SUCCESS

StatusInt mdlFilterMember_create	(	FilterMemberID *	piMemberIdOut,
		DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		WCharCP	pMemberNameIn,
		UShort	memberTypeIn
	)

Create a new member for specified filter-table.

All filters within the table will inherit the new member.

Parameters

[out]	piMemberIdOut	id of filter member created
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	pMemberNameIn	filter member name
[in]	memberTypeIn	member type ... One of FILTER_MEMBER_TYPE_...

Returns

ERROR if the filter table name is not valid or the member cannot be created, else SUCCESS

StatusInt mdlFilterMember_delete	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Delete member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

ERROR if the filter table name or member id is not valid, else SUCCESS

StatusInt mdlFilterMember_getExpression	(	WChar *	pExpressionStringOut,
		int	stringSizeIn,
		DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterID	iFilterIdIn,
		FilterMemberID	iMemberIdIn
	)

Get filter-member expression string.

Parameters

[out]	pExpressionStringOut	member expression string
[in]	stringSizeIn	number of characters pExpressionStringOut can hold
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iFilterIdIn	filter id
[in]	iMemberIdIn	filter member id

Returns

ERROR if the filter table name, filter id or member id is not valid, else SUCCESS

StatusInt mdlFilterMember_getExpressionSize	(	int *	pStringSizeOut,
		DgnModelRefP	pModelRefIn,
		const WChar *	pFilterTableNameIn,
		FilterID	iFilterIdIn,
		FilterMemberID	iMemberIdIn
	)

Get filter-member expression string size.

Parameters

[out]	pStringSizeOut	size of expression string
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iFilterIdIn	filter id
[in]	iMemberIdIn	filter member id

Returns

ERROR if the filter table name, filter id or member id is not valid, else SUCCESS

FilterMemberID mdlFilterMember_getFirst	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn
	)

Get the first member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name

Returns

first member if any, else NULL_FILTER_ID

StatusInt mdlFilterMember_getIdFromName	(	FilterMemberID *	pMemberIdOut,
		DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		WCharCP	pMemberNameIn
	)

Get id of member with specified name.

Parameters

[out]	pMemberIdOut	filter member id
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	pMemberNameIn	filter member name

Returns

ERROR if the filter table name or member name is not valid, else SUCCESS

FilterMemberID mdlFilterMember_getLast	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn
	)

Get the last member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name

Returns

last member if any, else NULL_FILTER_ID

StatusInt mdlFilterMember_getName	(	WChar *	pMemberNameOut,
		int	stringSizeIn,
		DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Get member name.

Parameters

[out]	pMemberNameOut	filter member name
[in]	stringSizeIn	number of characters pMemberNameOut can hold
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

ERROR if the filter table name or member id is not valid, else SUCCESS

FilterMemberID mdlFilterMember_getNext	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Get the next member after given member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

next member if any, else NULL_FILTER_ID

FilterMemberID mdlFilterMember_getPrevious	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Get the previous member before given member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

previous member if any, else NULL_FILTER_ID

StatusInt mdlFilterMember_getType	(	UShort *	pMemberTypeOut,
		DgnModelRefP	pModelRefIn,
		const WChar *	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Get member type.

Parameters

[out]	pMemberTypeOut	filter member id
[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

ERROR if the filter table name or member id is not valid, else SUCCESS

bool mdlFilterMember_isValid	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn
	)

Check if a member with specified id is valid.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id

Returns

true if the member is found, else false

bool mdlFilterMember_isValidByName	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		WCharCP	pMemberNameIn
	)

Check if a member with specified name is valid.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	pMemberNameIn	filter member name

Returns

true if the member is found, else false

StatusInt mdlFilterMember_setExpression	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterID	iFilterIdIn,
		FilterMemberID	iMemberIdIn,
		WCharCP	pExpressionStringIn
	)

Set filter-member expression string.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iFilterIdIn	filter id
[in]	iMemberIdIn	filter member id
[in]	pExpressionStringIn	member expression string - maybe NULL

Returns

ERROR if the filter table name, filter id or member id is not valid, else SUCCESS

StatusInt mdlFilterMember_setName	(	DgnModelRefP	pModelRefIn,
		WCharCP	pFilterTableNameIn,
		FilterMemberID	iMemberIdIn,
		WCharCP	pNameIn
	)

Set name of filter member.

Parameters

[in]	pModelRefIn	model ref
[in]	pFilterTableNameIn	filter table name
[in]	iMemberIdIn	filter member id
[in]	pNameIn	member name

Returns

ERROR if the filter table name or member id is not valid, else SUCCESS