OSI/AS Programming Manual

APS_DATA_GETPARAM_
APS Procedure Calls
056783 Tandem Computers Incorporated 3–63
APS_DATA_GETPARAM_ This procedure allows you to obtain the user data parameter from the last indication
or confirm primitive received. This procedure can be used after any indication or
confirm primitive that carries user data. Table 2-17 in Section 2 identifies these
primitives; Tables 2-2 and 2-4 in Section 2 give the names of the corresponding events.
error := APS_DATA_GETPARAM_ ( cepi ! I
, data-buffer-size ! I
,[ data-buffer ] ! O
,[ more-data ] ! O
,[ next-position ] ! O
,[ start-position ] ); ! I
error returned value
INT
indicates the outcome of the call. For the possible values of ZAPS-ERR-xxx, see
“Error Codes” in Appendix B. If no user data is available at the specified start
position, the error ZAPS-ERR-NO-DATA is returned.
cepi input
INT:value
is the connection endpoint identifier (CEPI) for this connection.
data-buffer-size input
INT(32):value
specifies the size, in bytes, of your user data buffer. This parameter indicates the
maximum number of bytes this procedure will return to you. The size you specify
must include the lengths of the data headers (ZAPS-DDL-DATA-HDR and one or
more occurrences of ZAPS-DDL-DATA-ELEMENT-HDR). If you specify a size of
0, no user data is returned, but the more-data parameter will specify the buffer
size needed to hold all of the data. (If the size you specify is nonzero and not
greater than the combined length of ZAPS-DDL-DATA-HDR and ZAPS-DDL-
DATA-ELEMENT-HDR, the API rejects the call with an error.)
data-buffer output
INT .EXT:ref:*
is the buffer into which the received data is to be copied. You must provide this
parameter if you specify a nonzero data-buffer-size . For information about
the structure of the buffer, see “Considerations.”