InteractiveInterfaces Interface CATIIniSearchNameCriterion
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIIniSearchNameCriterion
Interface to define a name-based search criterion.
Role: This interface enables the complete definition of
a search criterion on names as displayed in the Edit/Properties command,
and supported by the interface.
Method Index
- o
GetParameters(CATUnicodeString&,CATBoolean&,CATBoolean&,CATIniSearchEnumeration::Comparison&)
- Gets all the parameters of the criterion.
- o
SetParameters(CATUnicodeString&,CATBoolean,CATIniSearchEnumeration::Comparison)
- Sets all the parameters of the criterion.
- o
SetParameters(CATUnicodeString&,CATBoolean,CATBoolean,CATIniSearchEnumeration::Comparison)
- Sets all the parameters of the criterion.
Methods
o GetParameters
| public virtual GetParameters( | | oName, |
| | oCaseSensitive, |
| | oCodeSensitivity, |
| | oOperatingSign) |
-
Gets all the parameters of the criterion.
Role: This method completely retrieves all the
parameters of the name-based search criterion.
- Parameters:
-
- oName
- The name that is being looked for.
The
method gives the wild card character that 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
service.
Example:
If you are looking for objects that are called
You're a *, the string retrieved should be You''re a '*'.
- oCaseSensitivity
- If the case of oName is to be respected, the value must be TRUE.
Otherwise, it must be 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 TRUE.
- oOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- Returns:
-
- E_FAIL if the criterion is not correctly retireved: usually if oName is a
0-length CATUnicodeString, or if the oOperatingSign is not correct.
- S_OK otherwise.
o SetParameters
| public virtual SetParameters( | const | iName, |
| | iCaseSensitivity, |
| | iOperatingSign) |
-
Sets all the parameters of the criterion.
Role: This method completely defines all the
parameters of the name-based search criterion.
- Parameters:
-
- iName
- The name that is being looked for.
The
method gives the wild card character that 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
service.
Example:
If you are looking for objects that are called
You're a *, the string passed should be You''re a '*'.
- iCaseSensitivity
- If the case of iName 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.
- Returns:
-
- E_FAIL if the criterion is not correctly set up: usually if iName is a
0-length CATUnicodeString, or if the iOperatingSign is not correct.
- S_OK otherwise.
o SetParameters
| public virtual SetParameters( | const | iName, |
| | iCaseSensitivity, |
| | iCodeSensitivity, |
| | iOperatingSign) |
-
Sets all the parameters of the criterion.
Role: This method completely defines all the
parameters of the name-based search criterion.
- Parameters:
-
- iName
- The name that is being looked for.
The
method gives the wild card character that 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
service.
Example:
If you are looking for objects that are called
You're a *, the string passed should be You''re a '*'.
- iCaseSensitivity
- If the case of iName 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.
- iCodeSensitivity
- Some languages (Japanese for example) use two different unicode values for the
same character depending on whether the user types it using Double-byte
or Single-byte.
If such characters must be considered as different, the value must be TRUE.
Otherwise, it must be set to FALSE.
- iOperatingSign
- The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
- Returns:
-
- E_FAIL if the criterion is not correctly set up: usually if iName is a
0-length CATUnicodeString, or if the iOperatingSign is not correct.
- S_OK otherwise.
This object is included in the file: CATIIniSearchNameCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.