(Page 9 of 35 in this chapter)
TxX25FileShSumm
Description
- Sets up the packet as an file Show Summary packet for the specified file.
Prototype
- short TxX25FileShSumm (TXMNGPKT *req,
unsigned short index)
- req Pointer to packet to be set.
- index Index indicating first file to return in summary list.
Return Values
- TX API completion code.
Details
- The index parameter is used to indicate what file should be the first returned in the response packet. This value should be zero when beginning any show summary. If the repeat flag is set on a following call to TxX25FileShNext, the index specified by the show next function should be provided here. TxX25FileShSumm assumes that the packet is already a properly initialized management packet. Applications should call TxApiPktInit some time prior to calling TxX25FileShSumm.
- The response to a show summary file request should be handled by repeated calls to TxX25FileShNext.
- The response to a show summary LCN request should be handled by repeated calls to TxX25FileShNext which returns pointers to records within a summary block and tells when and which index to use for the next block.
- Each response record must be broken down directly by the application, referencing the TxX25_File_summ structure in X25type.h. No API assistance functions are provided for this operation. It is important that applications use the proper conversion functions when referencing any response fields to ensure processor independence is maintained. All fields are returned in the TX board byte ordering (MC680x0).
See Also
- TxApiPktInit, TxX25FileShNext
(Page 9 of 35 in this chapter)
tech_support@nmss.com
Copyright © 1998, Natural MicroSystems, Inc. All rights
reserved.