Google Git
Sign in
eclipse / gerrit / www.eclipse.org / openj9 / docs / eda6f0b9157feffd135f8b19f99c44da9b5dde9d / . / api / jdk16 / openj9.dtfj / com / ibm / dtfj / corereaders / zos / util / Clib.html
blob: 42b33e090674c66c21157345f80e00b4726e7c4a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>Clib (OpenJ9 JDK 16)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: module: openj9.dtfj, package: com.ibm.dtfj.corereaders.zos.util, class: Clib">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="com.ibm.dtfj.corereaders.zos.util.Clib class">
<meta name="keywords" content="SEEK_SET">
<meta name="keywords" content="SEEK_CUR">
<meta name="keywords" content="SEEK_END">
<meta name="keywords" content="fopen()">
<meta name="keywords" content="fgetpos()">
<meta name="keywords" content="fsetpos()">
<meta name="keywords" content="fseek()">
<meta name="keywords" content="fread()">
<meta name="keywords" content="perror()">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar.top">
<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div>
<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="../../../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Clib.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip.navbar.top">
<!-- -->
</span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../../module-summary.html">openj9.dtfj</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">com.ibm.dtfj.corereaders.zos.util</a></div>
<h1 title="Class Clib" class="title">Class Clib</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a>
<div class="inheritance">com.ibm.dtfj.corereaders.zos.util.Clib</div>
</div>
<section class="description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Clib</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div>
<div class="block">This class provides a low level interface to some of the z/OS C library. This approach was
inspired by the
<a href="https://www.eclipse.org/articles/Article-SWT-Design-1/SWT-Design-1.html">SWT design</a>
in that we have a one-to-one mapping between JNI calls and C library calls: no extra work is
done in the native functions. This is much easier to maintain because this library should
rarely need recompiling.
<p>
Please refer to the C library documentation for more details about arguments to these calls.
<p></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field.summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#SEEK_CUR">SEEK_CUR</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">fseek whence argument to indicate that offset is from the current position of the
file pointer</div>
</div>
<div class="col-first odd-row-color"><code>static int</code></div>
<div class="col-second odd-row-color"><code><span class="member-name-link"><a href="#SEEK_END">SEEK_END</a></span></code></div>
<div class="col-last odd-row-color">
<div class="block">fseek whence argument to indicate that offset is from the end of the file</div>
</div>
<div class="col-first even-row-color"><code>static int</code></div>
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="#SEEK_SET">SEEK_SET</a></span></code></div>
<div class="col-last even-row-color">
<div class="block">fseek whence argument to indicate that offset is from the beginning of the file</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor.summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><span class="member-name-link"><a href="#%3Cinit%3E()">Clib</a></span>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method.summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fgetpos(long,int%5B%5D)">fgetpos</a></span>&#8203;(long&nbsp;fp,
int[]&nbsp;pos)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around fgetpos.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static long</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fopen(byte%5B%5D,byte%5B%5D)">fopen</a></span>&#8203;(byte[]&nbsp;filename,
byte[]&nbsp;mode)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around fopen.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static long</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fopen(java.lang.String,java.lang.String)">fopen</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;filename,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;mode)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a slightly friendlier version of the native fopen call (the
parameters are Strings rather than byte arrays otherwise everything is the same).</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fread(byte%5B%5D,int,int,long)">fread</a></span>&#8203;(byte[]&nbsp;buf,
int&nbsp;size,
int&nbsp;count,
long&nbsp;fp)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around fread.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fseek(long,long,int)">fseek</a></span>&#8203;(long&nbsp;fp,
long&nbsp;offset,
int&nbsp;whence)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around fseek.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static int</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#fsetpos(long,int%5B%5D)">fsetpos</a></span>&#8203;(long&nbsp;fp,
int[]&nbsp;pos)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around fsetpos.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div>
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#perror(byte%5B%5D)">perror</a></span>&#8203;(byte[]&nbsp;prefix)</code></div>
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">This method is a wrapper around perror.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#perror(java.lang.String)">perror</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;prefix)</code></div>
<div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table">
<div class="block">Friendlier version of the native perror call that accepts a String parameter.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field.detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="SEEK_SET">
<h3>SEEK_SET</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">SEEK_SET</span></div>
<div class="block">fseek whence argument to indicate that offset is from the beginning of the file</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../../../constant-values.html#com.ibm.dtfj.corereaders.zos.util.Clib.SEEK_SET">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SEEK_CUR">
<h3>SEEK_CUR</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">SEEK_CUR</span></div>
<div class="block">fseek whence argument to indicate that offset is from the current position of the
file pointer</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../../../constant-values.html#com.ibm.dtfj.corereaders.zos.util.Clib.SEEK_CUR">Constant Field Values</a></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="SEEK_END">
<h3>SEEK_END</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">SEEK_END</span></div>
<div class="block">fseek whence argument to indicate that offset is from the end of the file</div>
<dl class="notes">
<dt>See Also:</dt>
<dd><a href="../../../../../../../constant-values.html#com.ibm.dtfj.corereaders.zos.util.Clib.SEEK_END">Constant Field Values</a></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor.detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Clib</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Clib</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method.detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="fopen(byte[],byte[])">
<h3>fopen</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">fopen</span>&#8203;<span class="parameters">(byte[]&nbsp;filename,
byte[]&nbsp;mode)</span></div>
<div class="block">This method is a wrapper around fopen.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>filename</code> - the name of the file to open as a null-terminated ebcdic byte array</dd>
<dd><code>mode</code> - the open mode which must be a null-terminated ebcdic byte array. See the
C library fopen documentation for more details</dd>
<dt>Returns:</dt>
<dd>the FILE stream pointer from fopen cast to a long</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fopen(java.lang.String,java.lang.String)">
<h3>fopen</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">fopen</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;filename,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;mode)</span></div>
<div class="block">This method is a slightly friendlier version of the native fopen call (the
parameters are Strings rather than byte arrays otherwise everything is the same).</div>
</section>
</li>
<li>
<section class="detail" id="fgetpos(long,int[])">
<h3>fgetpos</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">fgetpos</span>&#8203;<span class="parameters">(long&nbsp;fp,
int[]&nbsp;pos)</span></div>
<div class="block">This method is a wrapper around fgetpos. Here we make use of the knowledge that a C
fpos_t on z/OS is actually an array of 8 ints.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fp</code> - the stream obtained from an earlier call to fopen</dd>
<dd><code>pos</code> - this must be an array of 8 ints. The position indicator is stored in
this array. The same array contents may be passed to a subsequent fsetpos call.</dd>
<dt>Returns:</dt>
<dd>the return code from the fgetpos call (zero if successful)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fsetpos(long,int[])">
<h3>fsetpos</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">fsetpos</span>&#8203;<span class="parameters">(long&nbsp;fp,
int[]&nbsp;pos)</span></div>
<div class="block">This method is a wrapper around fsetpos.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fp</code> - the stream obtained from an earlier call to fopen</dd>
<dd><code>pos</code> - this must be an array of 8 ints whose contents were obtained in a previous
call to fgetpos.</dd>
<dt>Returns:</dt>
<dd>the return code from the fsetpos call (zero if successful)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fseek(long,long,int)">
<h3>fseek</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">fseek</span>&#8203;<span class="parameters">(long&nbsp;fp,
long&nbsp;offset,
int&nbsp;whence)</span></div>
<div class="block">This method is a wrapper around fseek. (Note: this hasn't been tested for seeks
over 2GB yet).</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fp</code> - the stream obtained from an earlier call to fopen</dd>
<dd><code>offset</code> - the offset to seek to</dd>
<dd><code>whence</code> - specifies where to seek from</dd>
<dt>Returns:</dt>
<dd>the return code from the fseek call (zero if successful)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="fread(byte[],int,int,long)">
<h3>fread</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">fread</span>&#8203;<span class="parameters">(byte[]&nbsp;buf,
int&nbsp;size,
int&nbsp;count,
long&nbsp;fp)</span></div>
<div class="block">This method is a wrapper around fread.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>buf</code> - the buffer to contain the read data</dd>
<dd><code>size</code> - the size of each element</dd>
<dd><code>count</code> - the number of elements to read</dd>
<dd><code>fp</code> - the stream obtained from an earlier call to fopen</dd>
<dt>Returns:</dt>
<dd>the number of elements read</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="perror(byte[])">
<h3>perror</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">perror</span>&#8203;<span class="parameters">(byte[]&nbsp;prefix)</span></div>
<div class="block">This method is a wrapper around perror.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>prefix</code> - the message prefix as a null-terminated ebcdic byte array</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="perror(java.lang.String)">
<h3>perror</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">perror</span>&#8203;<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>&nbsp;prefix)</span></div>
<div class="block">Friendlier version of the native perror call that accepts a String parameter.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>