## On this page

  

 

 # result:record reader

 Last update: 31.07.2026 

**Version: 0.0.0**

## Description

Extracts a record from a file.

## Supported file types

This operator supports the following keys ([file formats](../../index.md#overview-of-dpf)) for each listed namespace (plugin/solver):

- mapdl: rst, rstp, rth

## Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

Pin numberNameStatusExpected type(s)**3**[streams](#input_3)[`streams_container`](../../core-concepts/dpf-types.md#streams-container)**4**[data\_sources](#input_4)Required[`data_sources`](../../core-concepts/dpf-types.md#data-sources)**60**[record\_name](#input_60)Required<a id="input_3"></a>

### streams (Pin 3)

- **Required:** No
- **Expected type(s):** [`streams_container`](../../core-concepts/dpf-types.md#streams-container)

<a id="input_4"></a>

### data\_sources (Pin 4)

- **Required:** Yes
- **Expected type(s):** [`data_sources`](../../core-concepts/dpf-types.md#data-sources)

<a id="input_60"></a>

### record\_name (Pin 60)

- **Required:** Yes
- **Expected type(s):**

Name of the record that must be extracted from the file.

For example to read the nodal solution of the 4th set, input should be **RST::DSI::SET4::NSL**

The MAPDL records tree can be found in the following links:

- [Ansys Help - Retrieving Data from the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=//////Views/Secured/corp/v252/en/ans_prog/datafromRST.html)
- [Ansys Help - Description of the Results File](https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v252/en/ans_prog/Hlp_P_INT1_2.html)

## Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

Pin numberNameExpected type(s)0[field](#output_0)[`property_field`](../../core-concepts/dpf-types.md#property-field), [`field`](../../core-concepts/dpf-types.md#field)<a id="output_0"></a>

### field (Pin 0)

- **Expected type(s):** [`property_field`](../../core-concepts/dpf-types.md#property-field), [`field`](../../core-concepts/dpf-types.md#field)

Output is of type property\_field for integer records and of type field for double records.

## Configurations

This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior.

### [mutex](../../core-concepts/operator-configurations.md#mutex)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

## Scripting

This operator can be accessed through scripting interfaces using these identifiers.

**Category**: result

**Plugin**: mapdl

**Scripting name**: record\_reader

**Full name**: result.record\_reader

**Internal name**: record\_reader

**License**: None

## Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

C++```cpp
#include "dpf_api.h"

ansys::dpf::Operator op("record_reader"); // operator instantiation
op.connect(3, my_streams);
op.connect(4, my_data_sources);
op.connect(60, my_record_name);
ansys::dpf::PropertyField my_field = op.getOutput<ansys::dpf::PropertyField>(0);

```

CPython```python
import ansys.dpf.core as dpf

op = dpf.operators.result.record_reader() # operator instantiation
op.inputs.streams.connect(my_streams)
op.inputs.data_sources.connect(my_data_sources)
op.inputs.record_name.connect(my_record_name)
my_field_as_property_field = op.outputs.field_as_property_field()

```

IPython```python
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.result.record_reader() # operator instantiation
op.inputs.streams.Connect(my_streams)
op.inputs.data_sources.Connect(my_data_sources)
op.inputs.record_name.Connect(my_record_name)
my_field = op.outputs.field.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.