rapi_fmt_adspec()--Format a RAPI Adspec
Syntax
#include <rapi.h> void rapi_fmt_addspec( rapi_adspec_t *pAdspec, char *pBuffer, int size )
Service program name: QSYS/QTOQRAPI
Default public authority: *EXCLUDE
Threadsafe: Yes
The rapi_fmt_adspec() API formats a RAPI Adspec into a string suitable for printing by converting the RAPI Adspec information that has been passed to the API into a string in the supplied buffer. The Adspec is a data element in the RSVP "path" message that carries a package of OPWA advertising information. This information contains data about the available end-to-end service available to the receivers of data and can be used to predict what service is available. The output string is truncated if the length of the string exceeds the buffer size.
Parameters
- pAdspec
- (Input) Required
A pointer to the Adspec to be formatted.
- pBuffer
- (Input/Output) Required
A pointer to the buffer to be used.
- size
- (Input) Required
The length of the supplied buffer.
Authorities
None.
Return Value
None.
Error Conditions
None.
Usage Notes
This API can be used to format the contents of the Adspec information that has been to the API into a string that can be displayed at the local output device.
Related Information
For a description of the RSVP protocol, see RFC 2205 on the RFC Pages.
Complete documentation of the RAPI APIs can be found at The Open Group.
API introduced: V5R1