PLMWorkspaceInterfaces CATWSPCaptureServices

Usage: you must use this class as is. You should never derive it.


public class CATWSPCaptureServices

Class to manage services on persistent searches and filters.


Method Index


o Execute(CATIAdpPLMIdentificator*,CATListPtrCATIAdpPLMIdentificator&)
Executes a persistent search or filter.

Methods


o Execute
public static Execute( ipIdQueryToBeExecuted,
ioIdsListResults)
Executes a persistent search or filter.
Role: This method replays the specifications of a persistent search, or a persistent filter, from its identifier and returns the list of results' identifiers.
Parameters:
ipIdQueryToBeExecuted
[in] The identifier of a PLM object representing either a search or a filter in database.
  • For a search, the PLM Object type is a PLMWspQuery , the PLM Reference of the Query modeler
  • For a filter, the PLM Object type is a PLMWspPVS , the PLM Reference of the Filter modeler
ioIdsListResults
[in/out] The list of PLM Objects matching the query. The PLM Objects, represented by their identifier, are not loaded in session.
if afer the execution the list is not empty, each element of the list must be released.
Returns:
HRESULT The returned values can be:
  • S_OK The function has being executed successfully.
  • E_FAIL An error occurred during the execution of the function.
  • E_INVALIDARG if the provided ipIdQueryToBeExecuted is invalid.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.