---
name: "x3270if"
section: "1x"
platform: "linux"
package: "x3270"
version: "3.1.1.5-1"
release: "Debian 1.3 (Bo)"
platforms: ["linux"]
url: "https://new.carta.tech/x3270if/1x"
---

# x3270if(1x)

command interface to x3270

## NAME

x3270if - command interface to x3270

## SYNOPSIS

**x3270if** \[ **-v** \] *action* \[ **(** *param* \[ ,... \] **)** \]\
 **x3270if** \[ **-v** \] **-s** *field*

## DESCRIPTION

**x3270if** provides an interface between [*x3270*(1)](/x3270/1.md) and child processes run with the **Script()** action.

**x3270if** performs one of two functions: passing an action and optional parameters to *x3270* for execution, or reporting the value of one of *x3270*'s status fields.

The result of the command execution, or the value of the requested status field, is written to standard output.

## OPTIONS

- **-v**

  Turns on verbose debug messages, showing the literal data that is passed between *x3270* and **x3270if**.

- **-s** *field*

  Causes **3270if** to return the value of an *x3270* status field, rather than passing an action to be executed. *Field* is an integer in the range 0 through 11, indicating the desired status field. The indices and meanings of each field are documented on the [*x3270-script*(1)](/x3270-script/1.md) manual page.

## EXIT STATUS

If the requested *action* succeeds, **x3270if** exits with status 0. If the action fails, **x3270if** exits with status 1. If there is an operational error within **x3270if** itself, such as a command-line syntax error, missing environment variable, or closed pipe, **x3270if** exits with status 2.

## ENVIRONMENT

*x3270* uses a pair of pipes for communication with each child process. The values of the file descriptors for these pipes are encoded as text in two environment variables, which are required by **x3270if**:

- **X3270OUTPUT**

  Output from *x3270*, input to the child process.

- **X3270INPUT**

  Input to *x3270*, output from the child process.

## SEE ALSO

[*x3270*(1)](/x3270/1.md), *x3270-script*(1)

## COPYRIGHT

Copyright 1995 by Paul Mattes.

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation.