Purpose
Activate a set of conditions for which certain records of the server are to be excluded.
Class
Type
Method
Syntax
<oArrayServer>:SetFilter(
<cFilterCondition>,
[cbFilterCondition]
) Æ lSuccess
<oArrayServer>:SetFilter(<cbFilterCondition>) Æ lSuccess
Arguments
<cFilterCondition> | The condition for which records are to be excluded. If the argument <cbFilterCondition> is not indicated, the string is converted into a _Codeblock statement as follows: |
&("{|Server| "+uForCondition+"}")
Data Type: | String |
<cbFilterCondition> | The Condition as a CodeBlock for which records are to be excluded. |
Data Type: | Codeblock | _Codeblock-Object |
Return Value
lSuccess | A logical value that indicates whether the filter was activated. |
TRUE | The filter was activated. |
FALSE | The filter could not be activated. |
Data Type: | Logic |
Description
With a filter condition, records can be excluded from subsequent operations that do not correspond to the condition.
In order to be able to access in the condition <cFilterCondition> or <cbFilterCondition> to fields, accesses or methods of the server, the literal "Server" followed by a colon must be placed in front of these (see sample).
Samples
The following sample creates a filter on all records in those the field LASTNAME begins with the character "B". The condition is specified as string.
oasServer:SetFilter("Server:LASTNAME='B'")
The following sample creates a filter on all records in those the field LASTNAME begins with the character "B". The condition is specified as code block.
oasServer:SetFilter({|Server| Server:LASTNAME="B"})
See Also
Page url: http://www.YOURSERVER.com/index.html?barrayserver_setfilter.htm