493 lines
13 KiB
HTML
493 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Add File Server Share (QZLSADFS) API</title>
|
|
<!-- Begin Header Records ========================================= -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- QZLSADFS SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
|
|
<!-- at RCHVMW2 on 7 Oct 1998 at 21:21:14 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited Oct 2001 by Janet Brauckman -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Add File Server Share (QZLSADFS) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Share name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(12)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Path name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Length of path name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CCSID encoding of path name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Text description</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(50)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Permissions</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Maximum users</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Optional Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">9</td>
|
|
<td align="left" valign="top" width="50%">CCSID used for text conversion</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">Enable text conversion</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(1)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">File extension table</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="left" valign="top">Number of table entries</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Add File Server Share (QZLSADFS) API shares a portion of the integrated
|
|
file system with the network using the iSeries Support for Windows Network
|
|
Neighborhood server.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>To use this API, you must have *IOSYSCFG special authority or own the
|
|
integrated file system directory.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Share name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(12)
|
|
|
|
<p>The name of the share to be added.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Path name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The path in the integrated file system to be shared with the network. A
|
|
forward slash, '/', is required as the first character.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of path name</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length, in bytes, of the path name. The maximum length is 1024
|
|
bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>CCSID encoding of path name</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The coded character set ID (CCSID) of the path name and the file extension
|
|
table entries. 0 will result in the current job CCSID being used.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Text description</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(50)
|
|
|
|
<p>The text description for this share.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Permissions</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The access available from the network for this share.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Read only</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Read/Write</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Maximum users</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The maximum number of users who can concurrently access this share.</p>
|
|
|
|
<p>This value must be greater than or equal to zero, or -1 (X'FFFFFFFF'), which
|
|
means there is no limit to the number of users who can concurrently use this
|
|
share.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Optional Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>CCSID used for text conversion</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The client CCSID that is used for text file data conversion. Text file data
|
|
conversion is performed using this CCSID and the current CCSID of the system
|
|
file.</p>
|
|
|
|
<p>A value of 0 indicates that the user would like to use the currently
|
|
configured CCSID for the server. See the <a href="CDRGRDC.htm">Get Related
|
|
Default CCSID</a> (CDRGRDC) API for additional information on related
|
|
CCSIDs.</p>
|
|
|
|
<p>If the CCSID used for text conversion parameter is omitted, the API assumes
|
|
a default value of 0.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Enable text conversion</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(1)
|
|
|
|
<p>Whether the server enables text conversion for this share. Possible values
|
|
are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Text conversion not enabled</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Text conversion enabled</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Text conversion enabled and mixed data is
|
|
allowed</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the enable text conversion parameter is omitted, the API assumes a
|
|
default value of 0.</p>
|
|
</dd>
|
|
|
|
<dt><strong>File extension table</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>An array of table entries. There is no limit to the number of values
|
|
specified. For the layout of a table entry, see <a href="#HDRZLSAFET">Format of
|
|
File Extension Table Entry</a>.</p>
|
|
|
|
<p>If the file extension table parameter is omitted, the API assumes that there
|
|
are no file extensions for text conversion. If the file extension table
|
|
parameter is specified, the number of table entries parameter must be specified
|
|
also.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of table entries</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of table entries.</p>
|
|
|
|
<p>If the number of table entries parameter is left out, the API assumes a
|
|
default value of 0. If the number of table entries parameter is specified, the
|
|
file extension table parameter must be specified also.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRZLSAFET">Format of File Extension Table Entry</a></h3>
|
|
|
|
<p>The following shows the format of a file extension table entry. For detailed
|
|
descriptions of the fields in the table, see <a href="#HDRZLSAFED">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of file extension</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CHAR(46)</td>
|
|
<td align="left" valign="top">File extension</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRZLSAFED">Field Descriptions</a></h3>
|
|
|
|
<p><strong>File extension.</strong> A file extension string that is
|
|
null-terminated. Possible values include:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top" width="25%"><em>*</em></td>
|
|
<td align="left" valign="top" width="75%">The server will convert all
|
|
files.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>.</em></td>
|
|
<td align="left" valign="top">The server will convert all files without an
|
|
extension.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>TXT, .TXT</em></td>
|
|
<td align="left" valign="top">The server will convert all files ending with
|
|
.TXT (that is, a.TXT, a.b.c.TXT).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>..TXT, ...TXT, ......TXT</em></td>
|
|
<td align="left" valign="top">Extensions with more than one leading period will
|
|
have no effect on the server. No translation will be done.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>T*T</em></td>
|
|
<td align="left" valign="top">The server will convert all files ending with an
|
|
extension that substitutes any number of characters for the * wild card (that
|
|
is, a.T123T, b.TXT, c.TEST).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>T?T</em></td>
|
|
<td align="left" valign="top">The server will convert all files ending with an
|
|
extension that substitutes any one character for the ? wild card (that is,
|
|
a.T1T, b.TXT).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of file extension.</strong> The size in bytes of the file
|
|
extension. The length does not include the byte used for null-termination.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF3C1E E</td>
|
|
<td width="85%" valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C36 E</td>
|
|
<td valign="top">Number of parameters, &1, entered for this API was not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFA0D4 E</td>
|
|
<td valign="top">File system error occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB682 E</td>
|
|
<td valign="top">API &1 failed with reason code &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB683 E</td>
|
|
<td valign="top">Data conversion failed for API &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB684 E</td>
|
|
<td valign="top">User does not have the correct authority for API &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB68A E</td>
|
|
<td valign="top">Error occurred while working with shared resource &2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB68B E</td>
|
|
<td valign="top">Character is not valid for value &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFB68D E</td>
|
|
<td valign="top">Length specified in parameter &2 for API &1 not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPIB685 E</td>
|
|
<td valign="top">Error occurred on iSeries Support for Windows Network
|
|
Neighborhood (iSeries NetServer) request.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V4R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|