All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

InteractiveInterfaces Interface CATIIniSearchUserCriterion

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

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


interface CATIIniSearchUserCriterion

Interface to define a search criterion based on user-defined attributes.
Role: This interface enables the complete definition of a search criterion for a user-defined attribute.
This criterion has to be used to look for objects that have a user-defined 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&,CATIniSearchEnumeration::Comparison)
Sets all the parameters of the criterion.

Methods


o SetParameters
public virtual HRESULT SetParameters( const CATUnicodeString& iAttributeName,
const CATUnicodeString& iAttributeValue,
CATIniSearchEnumeration::Comparison iOperatingSign) = 0
Sets all the parameters of the criterion.
Role: This method sets all the parameters of the criterion.
Parameters:
iAttributeName
The name that was given to the user-defined attribute.
iAttributeValue
The value associated to the attribute.
iOperatingSign
The value corresponding to the desired operating sign.
The authorized values depend on the attribute's type (integer, listing, string, etc.).
Returns:
E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

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

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