NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PDM::SearchResult Class Reference

Represents search query
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::PDM::SearchResult:
NXOpen::TransientObject

Public Member Functions

std::vector< NXStringGetResultItemIds ()
 Gets a list of the item_ids from the search result. More...
 
std::vector< NXStringGetResultMfkIds ()
 Gets a list of the Multifield Keys from the search results. More...
 
std::vector< NXStringGetResultObjectNames ()
 Gets a list of the object names from the search result. More...
 
std::vector< NXStringGetResultObjectTypes ()
 Gets a list of the object types from the search result. More...
 
virtual ~SearchResult ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents search query
Created in NX6.0.0.


Constructor & Destructor Documentation

virtual NXOpen::PDM::SearchResult::~SearchResult ( )
virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX6.0.0.

License requirements : None

Member Function Documentation

std::vector<NXString> NXOpen::PDM::SearchResult::GetResultItemIds ( )

Gets a list of the item_ids from the search result.

If Multifield Key environment is enabled, then use Multifield key function PDM::SearchResult::GetResultMfkIds , as this function may return us duplicate item ids if the corresponding parts belong to different domains.

Returns
array of item_ids
Deprecated:
Deprecated in NX10.0.0. Use PDM::SearchResult::GetResultMfkIds instead.


Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::PDM::SearchResult::GetResultMfkIds ( )

Gets a list of the Multifield Keys from the search results.

If Multifield Key environment is enabled then always use this function Multifield Key: e.g. %MFK#%,=item_id=001, object_type=SupplierPart, supplier_code=x

Returns
array of mfk_ids
Created in NX10.0.0.

License requirements : None
std::vector<NXString> NXOpen::PDM::SearchResult::GetResultObjectNames ( )

Gets a list of the object names from the search result.

Returns
array of object names
Created in NX6.0.0.

License requirements : None
std::vector<NXString> NXOpen::PDM::SearchResult::GetResultObjectTypes ( )

Gets a list of the object types from the search result.

Returns
array of object types
Created in NX8.5.0.

License requirements : None

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.