All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMInterfaces Interface CATIVpmQuery

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


interface CATIVpmQuery

This class supplies methods to manage queries.
role: This class enables to get all information related to the query definition warning: To use this interface, do not consider only the module and framework shown at the bottom of this page. You must also add the GUIDVPMQueryBuilder module in your Imakefile.mk file, and the framework VPMQueryBuilder in your framework Identity card.


Method Index


o GetTimeLimit()
Gets the time limit over which the Query will be stopped.
o SetCaseSensitive()
Specifies that the query will be case sensitive.
o SetCaseUnsensitive()
Specifies that the query will be non case sensitive.
o SetTimeLimit(int)
Sets the time limit over which the Query will be stopped.

Methods


o GetTimeLimit
public virtual GetTimeLimit()
Gets the time limit over which the Query will be stopped.
Returns:
The current time limit value expressed in second. If it returns 0 (the default value), then the query keeps running until it ends.
o SetCaseSensitive
public virtual SetCaseSensitive()
Specifies that the query will be case sensitive.
o SetCaseUnsensitive
public virtual SetCaseUnsensitive()
Specifies that the query will be non case sensitive.
o SetTimeLimit
public virtual SetTimeLimit( iTime)
Sets the time limit over which the Query will be stopped.
Parameters:
iTime
This time value should be given in second. If iTime is <= 0 , the query will not be interrupted and the
GetTimeLimit returns 0.
Returns:
S_OK in all cases

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

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