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.PdmSearch Class Reference

Represents search query More...

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

Public Member Functions

unsafe NXOpen.PDM.SearchResult Advanced (string[] entries, string[] values)
 This API performs advanced search in the teamcenter and returns the result vector . More...
 
unsafe NXOpen.PDM.SearchResult Simple (string searchCriteria)
 Perform simple search in the teamcenter and returns the result vector. 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

unsafe NXOpen.PDM.SearchResult NXOpen.PDM.PdmSearch.Advanced ( string[]  entries,
string[]  values 
)
inline

This API performs advanced search in the teamcenter and returns the result vector .

Internally it will execute the NX standard Query "__NX_STD_ANY_ITEM_QUERY". Advanced search takes in detailed inputs to perform the search. The parameters "entries" and "values" are the internal property names and their values to be searched. The attribute/value pairs are combined logically using AND so that only objects matching ALL of the specified criteria are returned. The method can only be used to search for matches on Teamcenter properties that are string valued. It does not work for properties which are Object/LOV valued. For example "owning_user" is TC Object valued so the search does not find any matches when attempting to search on it. Please note, this functionality is available starting in Teamcenter 2007.1 MP2. To see how to spell the "real" attribute names rather than the displayed attribute (column) names, use Edit-> Options...-> General-> UI-> Sys Admin-> Real Property Name in the Rich Client.

Created in NX6.0.0

License requirements: None.

Parameters
entriessearch criteria entries
valuessearch criteria values
Returns
search result
override void NXOpen.PDM.PdmSearch.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 NXOpen.PDM.SearchResult NXOpen.PDM.PdmSearch.Simple ( string  searchCriteria)
inline

Perform simple search in the teamcenter and returns the result vector.

Internally it will execute the NX standard Query "__NX_STD_SIMPLE_ITEM_QUERY". ItemId should be given as the searchCriteria for searching the items Please note, this functionality is available starting in Teamcenter 2007.1 MP2.

Created in NX6.0.0

License requirements: None.

Parameters
searchCriteriasearch criteria as string
Returns
search result

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