# RXS_GetStmf()

This subprocedure retrieves up to 16MB of data from a specified IFS stream file.

## Subprocedure Prototype

### IBM i 7.1+

| Field | Description |
|---|---|
| `     D RXS_GetStmf...      D                 PR                  Extproc('RXS_GetStmf') Opdesc      D                                     Like(RXS_Var16Mv_t)      D                                     Rtnparm` | Returns data retrieved from the specified IFS stream file. |
| `     D   DS                                Likeds(RXS_GetStmfDS_t)` | RXS_GetStmfDS_t data structure used to configure the RXS_GetStmf() call and specify the IFS stream file to read. |


### IBM i 6.1

| Field | Description |
|---|---|
| `     D RXS_GetStmf...      D                 PR                  Extproc('RXS_GetStmf')` |  |
| `     D   Output                            Like(RXS_Var16Mv_t)      D                                     Options(*Varsize)` | Holds the data retrieved from the specified IFS stream file. |
| `     D   DS                                Likeds(RXS_GetStmfDS_t)      D                                     Options(*Varsize)` | RXS_GetStmfDS_t data structure used to configure the RXS_GetStmf() call and specify the IFS stream file to read. |


## Example Code

### IBM i 7.1+

#### Example 1: Read Character String from IFS stream file
```rpgle
      *--------------------------------------------------------------
      * This example code reads the contents of the file 
      * /tmp/rxs_getstmf.txt into the Data field.
      *--------------------------------------------------------------
     H DFTACTGRP(*NO) BNDDIR('RXSBND') ACTGRP(*CALLER)

      /copy QRPGLECPY,RXSCB

     D GetStmfDS       DS                  LikeDS(RXS_GetStmfDS_t)
     D                                     Inz(*LikeDS)
     D Data            S                   Like(RXS_Var64Kv_t)
      /free

       reset GetStmfDS;
       GetStmfDS.Stmf = '/tmp/rxs_getstmf.txt';
       Data = RXS_GetStmf( GetStmfDS );

       *INLR = *ON;
      /end-free
```

### IBM i 6.1

#### Example 1: Read Character String from IFS stream file
```rpgle
      *--------------------------------------------------------------
      * This example code reads the contents of the file 
      * /tmp/rxs_getstmf.txt into the Data field.
      *--------------------------------------------------------------
     H DFTACTGRP(*NO) BNDDIR('RXSBND') ACTGRP(*CALLER)

      /define RXSV6R1
      /copy QRPGLECPY,RXSCB

     D GetStmfDS       DS                  LikeDS(RXS_GetStmfDS_t)
     D                                     Inz(*LikeDS)
     D Data            S                   Like(RXS_Var64Kv_t)
      /free

       reset GetStmfDS;
       GetStmfDS.Stmf = '/tmp/rxs_getstmf.txt';
       RXS_GetStmf( Data : GetStmfDS );

       *INLR = *ON;  
      /end-free
```

## Data Structures

### RXS_GetStmfDS_t

| Field | Description |
|---|---|
| `     D RXS_GetStmfDS_t...      D                 DS                  Qualified Template Inz` |  |
| `     D   ReturnedErrorInfo...      D                                     LikeDS(RXS_ReturnedErrorInfoDS_t) Inz` |  |
| `     D   OnErrorMessageType...      D                                5I 0` |  |
| `     D   Stmf                              Like(RXS_Var1Kv_t)` | Specifies IFS path to a stream file to retrieve. |
| `     D   ToCcsid                     10I 0` | The CCSID to convert the data read from the IFS stream file into. |
| `     D   OutputPointer...      D                                 *   Inz(*Null)` | **Internal use only** |
| `     D   OutputLength                10I 0` | **Internal use only** |