,ANSAREA=ansarea

One of a set of mutually exclusive keywords indicating a storage area into which XCF is to store the results of the request.

If the ANSAREA is not large enough to hold the answer area header (mapped by IXCYNOTE_TANSAREA), the request is rejected outright (IXCNOTERSNANSLENBADVAL). If the ANSAREA is large enough for the header, but not large enough to hold all the requested output data, the service routine returns with a return and reason code indicating that the ANSAREA needs to be bigger. In cases where the answer areas is not large enough for requests that return a static number of records, the request is rejected with reason code IXCNOTERSNANSLENMORE. In cases where the answer area is not large enough for requests that return a variable number of records, the answer area is filled with as many records as will fit and the service routine returns with a warning return code and a reason indicating that there is additional data available (IXCNOTERSNMOREDATA or IXCNOTERSNMORENOTES). For reason IXCNOTERSNMORENOTES, the caller can reissue the request with the resultant RESUMETOKEN value to continue reading the remaining notes. For the other reasons, the answer area header indicates how much storage is needed to contain the requested data (AA_ANSAREASIZENEEDED). As appropriate, the caller should obtain a sufficiently large answer area and reissue the request.

The storage containing the ANSAREA must reside in the primary address space of the caller, or in a space addressable via a public entry on the Dispatchable Unit Access List (DU-AL), or in a common area data space. The storage must be accessible using the PSW key of the program making the request.

Note that the answer area storage can be used by XCF as a work area. In particular, some or all of the answer area might be updated regardless of whether the request completes successfully or not. The answer area will be valid for use for any return and reason code that indicates that an answer area is stored.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,NOANSAREA

One of a set of mutually exclusive keywords indicating that no answer area is being provided. XCF will process the request and provide a suitable return and reason code, but an answer area will not be stored.

This specification is not permitted for REQUEST=NOTES REQTYPE=READ since an answer area is a required input for that request.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter might be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,mfctrl

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,mfattr

An optional 1 to 60 character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code mfattr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

REQUEST=NOTEPAD

Process a note pad. For parameter descriptions applicable to REQUEST=NOTEPAD, see Parameters for REQUEST=NOTEPAD.

REQUEST=CONNECTION

Process a connection to a note pad. For parameter descriptions applicable to REQUEST=CONNECTION, see Parameters for REQUEST=CONNECTION.

REQUEST=NOTE

Process a single note in the note pad associated with the indicated connection.

The keyword NAME identifies the note to be manipulated. For create, write, or replace requests, the note content will be fetched from the storage area identified by the BUFFER keyword. For read and delete requests, BUFFER indicates where the content of the note is to be stored.

A NOTE request can be issued by a work unit that can satisfy any of the following conditions:

• Requester is the connector
• Home is connector address space and has appropriate SAF authorization
• Supervisor state or PKM allowing key 0-7, and:
  • Connection created with USAGE=CLIENT, or
  • Connection created with USAGE=SERVER and primary is the connector space, or
  • Running as an address space resource manager

For parameter descriptions applicable to REQUEST=NOTE, see Parameters for REQUEST=NOTE.

REQUEST=NOTES

Process a collection of notes in the note pad.

The CHOOSE keyword determines the set of notes to be processed. One can either read or delete the selected notes.

Requests to process multiple notes could be long running.

A NOTES request can be issued by a work unit that can satisfy any of the following conditions:

• Requester is the connector
• Home is connector address space and has appropriate SAF authorization
• Supervisor state or PKM allowing key 0-7, and:
  • Connection created with USAGE=CLIENT, or
  • Connection created with USAGE=SERVER and primary is the connector space, or
  • Running as an address space resource manager

For parameter descriptions applicable to REQUEST=NOTES, see Parameters for REQUEST=NOTES.

To code: Specify the RS-type address of a fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or (R15).

To code: Specify the RS-type address of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00), REG0), (REG00), or (R0).