In this section: How to: |
The DSTMEM subroutine maintains single members in a Distribution List stored in BOTDEST. It is a procedure-based call. With this subroutine, you can:
-SET &var_name=DSTMEM(srv_userid,srv_userid_length, - 'srv_userpass',srv_userpass_length, - 'host_port',host_port_length, - 'name',name_length, - 'function',function_length, - 'owner',user_length, - 'fldvlu',fldvlu_length, - 'destfn',destfn_length, - 'httpuser/pswd',httpuser/pswd_length, [- 'tcpiplevel',] - 'I4');
where:
Is the variable that will contain the return code.
The following sections describe the arguments for the DSTMEM subroutine. For an example that uses the DSTMEM subroutine, see Adding a New Member to a Distribution List Using DSTMEM.
Description |
Valid Execution ID. |
Required? |
Yes |
Format |
A48 (Windows and UNIX)A8 (OS/390) |
Valid Values |
Single quotation marks, ampersands, and spaces are not allowed. First character must be alphanumeric (OS/390). |
Description |
Length of the user ID. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Valid password for the Execution ID. |
Required? |
Yes |
Format |
A48 |
Valid Values |
Alphanumeric characters and spaces are allowed. |
Description |
Length of the password for the Execution ID. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Is the host name (or IP address) and port number of the Web server on which the WebFOCUS Client is installed.
|
Required? |
Yes |
Format |
A64 |
Valid Values |
No restrictions. |
Description |
Is the length of the host name and port number. This is only the length of the host name if the port number is omitted. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Name of the Distribution List that will be modified. |
Required? |
Yes |
Format |
A50 |
Valid Values |
First character must be alphabetic. |
Description |
Length of the name of the Distribution List. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Type of maintenance action that will be performed. |
Required? |
Yes |
Format |
A1 |
Valid Values |
A = Add a new member. D = Delete an existing member. |
Description |
Length of the value of the function. |
Required? |
Yes |
Format |
I4 |
Valid Values |
1 |
Description |
User ID of the Distribution List owner being added to or deleted from. |
Required? |
Yes |
Format |
A48 (Windows and UNIX)A8 (OS/390) |
Valid Values |
Single quotation marks, ampersands, and spaces are not allowed.First character must be alphanumeric. |
Description |
Length of the user ID of the owner of the Distribution List being added to or deleted from. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Field value on which the report is burst. |
Required? |
Yes, if the report is burst. |
Format |
A75 |
Valid Values |
Burst value |
Description |
Length of the burst value. |
Required? |
Yes, if fldvlu is supplied. |
Format |
I4 |
Valid Values |
I4 |
Description |
Destination of the report or report section. |
Required? |
Yes |
Format |
A75 |
Valid Values |
File name if the method is FTP. E-mail address if the method is MAIL. Printer name if the method is PRINT. |
Description |
Length of the destination value. |
Required? |
Yes |
Format |
I4 |
Valid Values |
Integer |
Description |
Web server user ID and password. |
Required? |
Yes, if the Web server is running with security on. |
Format |
A75 |
Valid Values |
Valid Web server user ID and password. |
Description |
Length of the Web server user ID and password, including the character /. |
Required? |
Yes, if httpuser/pswd is supplied. |
Format |
I4 |
Valid Values |
Integer |
Description |
Method ReportCaster uses for securing sockets from TCP/IP, based on a specific SAS/C library. |
Required? |
Yes, if the WebFOCUS Reporting Server runs on OS/390. |
Format |
I4 |
Valid Values |
1 = Resolves special connectivity problems. 0 = Specifies no special connectivity problems. |
Description |
Value that DSTMEM returns to the calling procedure, indicating successful completion (0) or an error condition. |
Required? |
Yes |
Format |
I4 |
Valid Values |
'I4' |
The following Dialogue Manager procedure calls DSTMEM to add a new member to a Distribution List. The procedure resides on a WebFOCUS Reporting Server on Windows. The numbers to the left of the code refer to the annotations that follow.
1. FILEDEF SUBLOG DISK D:\ibi\srv77\wfs\catalog\sublog.ftm -RUN 2. -SET &SUBERR = DSTMEM( - 'userid',6, 3. - 'mypass',6, 4. - 'ibiwnt:3794',11, 5. - 'Managers',8, 6. - 'A',1, 7. - 'listownerId',11, 8. - &VAR1,&VAR2, 9. - &VAR3,&VAR4, 10. - ' ',0, 11. - 'I4'); 12. -IF &SUBERR EQ 0 GOTO EXIT; -INCLUDE DSTMEMER -WRITE SUBLOG &SUBERR -EXIT
The procedure runs as follows:
For more information about the FILEDEF command, see the Developing Reporting Applications manual.
The Execution ID ('userid'), included in single quotation marks, and length of 'userid' (6), are the first arguments passed to the subroutine.
If it is a non-zero value, indicating an error condition, the procedure continues to the next line, which incorporates the supplied file DSTMEMER. DSTMEMER translates return codes into meaningful messages. Messages are written to the file sublog.ftm, which was defined by the FILEDEF command in the first line of code.
For more information about DSTMEMER, see ReportCaster API Subroutine Messages.
Note: The initial hyphen and space on each line are required for a continuation line.
WebFOCUS |