All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchLayerCriterion

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIIniSearchLayerCriterion

Interface to define a layer-based search criterion.
Role: This interface enables the complete definition of a search criterion on the layer attribute.
The objects found will match the layer number and operating sign, as specified in the method.

Method Index

o GetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison&): Retrives all the parameters of the criterion.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison): Sets all the parameters of the criterion.

Methods

o GetParameters

public virtual GetParameters(		`oLayer`,
		`oOperatingSign`)

Retrives all the parameters of the criterion.
Role: This method Retrives all the parameters of the criterion.

Parameters:

oLayer: The layer number for objects to be found.
It can be a number or NoneLayer, if the criterion is for objects that do not belong to any layer.
oOperatingSign: The value corresponding to the desired operating sign.
All values are authorized.

Returns:

E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

o SetParameters

public virtual SetParameters(	const	`iLayer`,
		`iOperatingSign`)

Sets all the parameters of the criterion.
Role: This method sets all the parameters of the criterion.

Parameters:

iLayer: The layer number for objects to be found.
It can be a number or NoneLayer, if the criterion is for objects that do not belong to any layer.
iOperatingSign: The value corresponding to the desired operating sign.
All values are authorized.

Returns:

E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

This object is included in the file: CATIIniSearchLayerCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces