rapi_release()--Release the currently active RAPI reservation
Syntax
#include <rapi.h> int rapi_release( rapi_sid_t SessID )
Service program name: QSYS/QTOQRAPI
Default public authority: *EXCLUDE
Threadsafe: Yes
The rapi_release() API releases the RAPI reservation that is active currently and closes the open sessions. This call is made implicitly if the application terminates without closing its RSVP sessions.
Parameters
- SessID
- (Input) Required
The session ID returned by a successful rapi_session() call.
Authorities
None.
Return Value
Returns 0 if successful.
Returns a RAPI error code if not successful.
Error Conditions
- [RAPI_ERR_BADSID]
-
The session ID passed to the API did not correspond to a valid RAPI session.
- [RAPI_ERR_NORSVP]
-
The RSVP server was not detected. Make sure the server has been started.>
Usage Notes
- The rapi_session() API must be called to establish a
session ID to be used with the other RAPI APIs.
- The RSVP server must be running before any of the RAPI APIs are called.
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