Click or drag to resize

VoDbSetFilter Function

Set a filter condition.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.7
 FUNCTION VoDbSetFilter(
	cbCondition AS USUAL,
	cCondition AS STRING
Request Example View Source


Type: Usual
A code block that expresses the filter condition in executable form.
Type: String
A character value that expresses the filter condition in textual form.
It must be equivalent to <cbCondition>.
To omit, specify a NULL_STRING.  <cCondition> is the value returned by the DBFilter() function.

Return Value

Type: Boolean
TRUE if successful; otherwise, FALSE.
If <cCondition> is omitted, the DBSetFilter() function will return an empty string for the work area.
VODBSetFilter() is like DBSetFilter() but is strongly typed.
This function, however, does not call the error handler and will not, therefore, produce a runtime error message or create an error object if it fails.  Thus, it may be important to check the return value to determine if the function succeeded.
The global structure, StrucErrInfo, will contain needed information regarding any error that occurs.  See DBSetFilter() for more information and an example.