SearchResult Class — NXOpen Python API Reference 12.0.0 documentation

# SearchResult Class

class `NXOpen.PDM.``SearchResult`

  Bases: `NXOpen.TransientObject`

  Represents search query

  New in version NX6.0.0.

# Methods

Method | Description
--- | ---
Dispose | Frees the object from memory.
GetResultItemIds | Gets a list of the item_ids from the search result.
GetResultMfkIds | Gets a list of the Multifield Keys from the search results.
GetResultObjectNames | Gets a list of the object names from the search result
GetResultObjectTypes | Gets a list of the object types from the search result

# Method Detail

## Dispose

`SearchResult.``Dispose`

  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.

  Signature `Dispose()`

  New in version NX6.0.0.

  License requirements: None.

## GetResultItemIds

`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.

  Signature `GetResultItemIds()`

  Returns: | array of item_ids
  Return type: | list of str

  New in version NX8.5.0.

  Deprecated since version NX10.0.0: Use `PDM.SearchResult.GetResultMfkIds()` instead.

  License requirements: None.

## GetResultMfkIds

`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

  Signature `GetResultMfkIds()`

  Returns: | array of mfk_ids
  Return type: | list of str

  New in version NX10.0.0.

  License requirements: None.

## GetResultObjectNames

`SearchResult.``GetResultObjectNames`

  Gets a list of the object names from the search result

  Signature `GetResultObjectNames()`

  Returns: | array of object names
  Return type: | list of str

  New in version NX6.0.0.

  License requirements: None.

## GetResultObjectTypes

`SearchResult.``GetResultObjectTypes`

  Gets a list of the object types from the search result

  Signature `GetResultObjectTypes()`

  Returns: | array of object types
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.