All Frameworks Class Hierarchy This Framework Previous Next Indexes
InteractiveInterfaces Interface CATIIniSearchStringCriterion
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---InteractiveInterfaces.CATIIniSearchCriterion
|
+---CATIIniSearchStringCriterion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIIniSearchStringCriterion
Interface to define a string-based attribute criterion.
Role: This interface enables the complete definition of
a search criterion on string attributes.
This criterion has to be used to look for objects that have
a string type attribute (as defined through Knowledgeware).
Such a criterion must always be used in conjunction with
a CATIIniSearchTypeCriterion, as a second argument of the
CATIIniSearchAndCriterion.SetParameters criterion.
Method Index
- o
SetParameters(CATUnicodeString&,CATUnicodeString&,CATBoolean,CATIniSearchEnumeration::Comparison,CATUnicodeString)
- Sets all the parameters of the criterion.
Methods
o SetParameters
-
Sets all the parameters of the criterion.
Role: This method sets all the parameters of
the criterion.
- Parameters:
-
- iAttributeInternalName
- The internal name of the string attribute that is being looked for.
To retrieve this piece of information you can proceed as follows:
- Record a macro command on a scenario based on the Edit/Search
command with your Search query as input (NLS based query).
- Check the macro file. It contains the query under the following
format: WorkbenchInternalName.TypeInternalName.iAttributeInternalName operator value
- iAttributeValue
- The value associated to the attribute.
The
CATIIniSearchServices.GetWildCardCharacter character replaces from 0 to n characters. If this character is a character by itself, enclose it
within single quotes. If the quote character is a character by itself, double it.
The easiest is to use the
CATIIniSearchServices.CorrectString service.
- iCaseSensitivity
- If the case of iAttributeValue is to be respected, the value must be TRUE.
Otherwise, it must be set to FALSE.
Example:
If you are looking for objects whose name contains the
Shell string, without objects whose name contains the shell
string, the value should be set to TRUE.
- iOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- iAttributeNLSName
- This parameter is only required for printing out the query.
If no string is provided here, an NLS print of the query
would display the attribute's NLS name, provided the query
has been run at least once on a document containing at least
one object with the specified attribute.
- Returns:
- E_FAIL if the criterion is not correctly set up.
S_OK otherwise.
This object is included in the file: CATIIniSearchStringCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces