NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | List of all members
NXOpen.PDM.SearchResult Class Reference

Represents search query More...

Inheritance diagram for NXOpen.PDM.SearchResult:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe string[] GetResultItemIds ()
 Gets a list of the item_ids from the search result. More...
 
unsafe string[] GetResultMfkIds ()
 Gets a list of the Multifield Keys from the search results. More...
 
unsafe string[] GetResultObjectNames ()
 Gets a list of the object names from the search result More...
 
unsafe string[] GetResultObjectTypes ()
 Gets a list of the object types from the search result More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents search query

Created in NX6.0.0

Member Function Documentation

override void NXOpen.PDM.SearchResult.FreeResource ( )
inlineprotectedvirtual

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.

Implements NXOpen.TransientObject.

unsafe string [] NXOpen.PDM.SearchResult.GetResultItemIds ( )
inline

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.

Created in NX8.5.0

Deprecated in NX10.0.0. Use PDM.SearchResult.GetResultMfkIds instead.

License requirements: None.

Returns
array of item_ids
unsafe string [] NXOpen.PDM.SearchResult.GetResultMfkIds ( )
inline

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

Created in NX10.0.0

License requirements: None.

Returns
array of mfk_ids
unsafe string [] NXOpen.PDM.SearchResult.GetResultObjectNames ( )
inline

Gets a list of the object names from the search result

Created in NX6.0.0

License requirements: None.

Returns
array of object names
unsafe string [] NXOpen.PDM.SearchResult.GetResultObjectTypes ( )
inline

Gets a list of the object types from the search result

Created in NX8.5.0

License requirements: None.

Returns
array of object types

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