Create SNADS File Server Object (QZDCRFSO) API


  Required Parameter Group:

1 File server object handle Output Char(32)
2 File server object data length Input Binary(4)
3 File server name structure Input Char(68)
4 Error code I/O Char(*)

  Default Public Authority: *EXCLUDE

  Threadsafe: No

The Create SNADS File Server Object (QZDCRFSO) API allows a user to create a file server object (FSO). A file server object also may be referred to as an attachment (MSF messages, for example, can have attachments). The types of file server objects that the QZDCRFSO API builds are SNADS general file-server objects and Document Interchange Architecture (DIA) file-server objects. The interface is the same to these two types of objects.


Authorities and Locks

API Public Authority
*EXCLUDE

Required Parameter Group

File server object handle
OUTPUT; CHAR(32)

The necessary linkage to the file server object. This parameter is set as output on the create operation and is used as input on all other file server functions.

File server object data length
INPUT; BINARY(4)

The calculated length of the data to be written. The API creates an FSO space (up to 16MB) that is big enough to hold the length of data specified. If you specify too small a size, there is no problem. SNADS creates an FSO of the size you specify, but if the actual size is larger, SNADS extends the FSO. For better performance, you should specify the actual size of the FSO. Valid values for this parameter are:

1 byte through 16 megabytes

File server name structure
INPUT; CHAR(68)

The file server name (either DIA or SNADS) and the server name length.

Offset Type Field
Dec Hex
0 0 BINARY(4) Length of file server name
4 4 CHAR(64) File server name

The length of the file server name is the number of bytes in the file server name defined by the SNADS architecture. Valid values for length of the file server name are as follows:

4 SNADS general file-server name
4 DIA file-server name

The file server name is the name value defined by the SNADS architecture for the file server that is to be used. The only file servers available with this API are the SNADS general file server and the DIA file server. Valid values for file server name:

'21F0F0F6'X SNADS general file-server name
'20F0F0F1'X DIA file-server name

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3A0D E Temporary server error.
CPF3A09 E System error.
CPF3A1D E Limit of number of open file server objects exceeded.
CPF3A17 E Permanent server error.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API Introduced: V3R6

[ Back to top | Office APIs | APIs by category ]