Add File Server Share (QZLSADFS) API
Required Parameter Group:
| 1 | Share name | Input | Char(12) |
| 2 | Path name | Input | Char(*) |
| 3 | Length of path name | Input | Binary(4) |
| 4 | CCSID encoding of path name | Input | Binary(4) |
| 5 | Text description | Input | Char(50) |
| 6 | Permissions | Input | Binary(4) |
| 7 | Maximum users | Input | Binary(4) |
| 8 | Error code | I/O | Char(*) |
Optional Parameter Group
1
:| 9 | CCSID used for text conversion | Input | Binary(4) |
| 10 | Enable text conversion | Input | Char(1) |
| 11 | File extension table | Input | Char(*) |
| 12 | Number of table entries | Input | Binary(4) |
Optional Parameter Group 2:| 13 | Encryption required | Input | Char(1) |
Default Public Authority: *USE
Threadsafe: No
The Add File Server Share (QZLSADFS) API shares a portion of the integrated file system with the network using the IBM® i Support for Windows® Network Neighborhood (IBM i NetServer™) server.
Authorities and Locks
To use this API, you must have *IOSYSCFG special authority or own the integrated file system directory.
Required Parameter Group
- Share name
- INPUT; CHAR(12)
The name of the share to be added.
- Path name
- INPUT; CHAR(*)
The path in the integrated file system to be shared with the network. A forward slash, '/', is required as the first character.
- Length of path name
- INPUT; BINARY(4)
The length, in bytes, of the path name. The maximum length is 1024 bytes.
- CCSID encoding of path name
- INPUT; BINARY(4)
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.
- Text description
- INPUT; CHAR(50)
The text description for this share.
- Permissions
- INPUT; BINARY(4)
The access available from the network for this share.
1 Read only 2 Read/Write
- Maximum users
- INPUT; BINARY(4)
The maximum number of users who can concurrently access this share.
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.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Optional Parameter Group 1
- CCSID used for text conversion
- INPUT; BINARY(4)
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.
A value of 0 indicates that the user would like to use the currently configured CCSID for the server. See Get Related Default CCSID (CDRGRDC) API for additional information on related CCSIDs.
If the CCSID used for text conversion parameter is omitted, the API assumes a default value of 0.
- Enable text conversion
- INPUT; CHAR(1)
Whether the server enables text conversion for this share. Possible values are:
0 Text conversion not enabled 1 Text conversion enabled 2 Text conversion enabled and mixed data is allowed If the enable text conversion parameter is omitted, the API assumes a default value of 0.
- File extension table
- INPUT; CHAR(*)
An array of table entries. There is no limit to the number of values specified. For the layout of a table entry, see Format of File Extension Table Entry.
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.
- Number of table entries
- INPUT; BINARY(4)
The number of table entries.
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.
Optional Parameter Group 2
All parameters in optional parameter group 1 must be specified when optional parameter group 2 is specified.
- Encryption required
- INPUT; CHAR(1)
Whether the server requires access to the share to use encryption. Possible values are:
0 Access to the share does not require encryption 1 Access to the share can only be made from an SMB 3 or newer client with encryption enabled. Unencrypted access to this share is denied. If the encryption required parameter is omitted, the API assumes a default value of 0.
Format of File Extension Table Entry
The following shows the format of a file extension table entry. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of file extension |
| 4 | 4 | CHAR(46) | File extension |
Field Descriptions
File extension. A file extension string that is null-terminated. Possible values include:
| * | The server will convert all files. |
| . | The server will convert all files without an extension. |
| TXT, .TXT | The server will convert all files ending with .TXT (that is, a.TXT, a.b.c.TXT). |
| ..TXT, ...TXT, ......TXT | Extensions with more than one leading period will have no effect on the server. No translation will be done. |
| T*T | 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). |
| T?T | 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). |
Length of file extension. The size in bytes of the file extension. The length does not include the byte used for null-termination.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPFA0D4 E | File system error occurred. |
| CPFB682 E | API &1 failed with reason code &2. |
| CPFB683 E | Data conversion failed for API &1. |
| CPFB684 E | User does not have the correct authority for API &1. |
| CPFB68A E | Error occurred while working with shared resource &2. |
| CPFB68B E | Character is not valid for value &3. |
| CPFB68D E | Length specified in parameter &2 for API &1 not valid. |
| CPIB685 E | Error occurred on IBM i Support for Windows Network Neighborhood (IBM i NetServer) request. |
API introduced: V4R2