Change File Server Share (QZLSCHFS) 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)

  Optional Parameter Group 3:

14

Authorization list

Input

Char(10)

  Default Public Authority: *USE

  Threadsafe: No

The Change File Server Share (QZLSCHFS) API changes the information about a shared portion of the integrated file system.

Authorities and Locks

To use this API, you must have *IOSYSCFG special authority or own the integrated file system directory. If an authorization list is set, you must have at least *USE authority to the authorizaiton list.

Required Parameter Group

Share name

INPUT; CHAR(12)

The name of the share to be changed.

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. Possible values follow.

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 that no change is requested and the current value remains unchanged.

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 that no change is requested and the current value remains unchanged.

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 no change is requested and current values remain unchanged. 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 that no change is requested and the current value remains unchanged. 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 that no change is requested and the current value remains unchanged.

Optional Parameter Group 3

All parameters in optional parameter groups 1 and 2 must be specified when optional parameter group 3 is specified.

Authorization list

INPUT; CHAR(10)

The name of the authorization list that defines the user access restrictions to be applied to the share. Users with *ALLOBJ special authority will bypass any authorization list restrictions.

If the authorization list parameter is blank, no authorization list restrictions will be applied to the share. If the authorization list parameter is omitted, any current authorization list restrictions will remain unchanged.

Format of File Extension Table Entry

The following table shows the format of a file extension table entry. For detailed descriptions of the fields in the table, see Field Descriptions.

Field Descriptions

File extension. A file extension string that is null-terminated. Possible values include:

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

[ Back to top | Server Support APIs | APIs by category ]