All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

InteractiveInterfaces Interface CATIIniSearchJapaneseNameCriterion

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---InteractiveInterfaces.CATIIniSearchCriterion
        |
        +---CATIIniSearchJapaneseNameCriterion
 

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


interface CATIIniSearchJapaneseNameCriterion

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 CATIAlias interface.


Method Index


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

Methods


o SetParameters
public virtual HRESULT SetParameters( const CATUnicodeString& iName,
CATBoolean iCaseSensitivity,
CATBoolean iCodeSensitivity,
CATIniSearchEnumeration::Comparison iOperatingSign) = 0
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
CATIIniSearchServices.GetWildCardCharacter 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 CATIIniSearchServices.CorrectString 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: CATIIniSearchJapaneseNameCriterion.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.