HP-UX C SIP Stack Programmer's Guide (Novembery 2007)

API Conventions 29
3
API CONVENTIONS
INTRODUCTION The SIP Stack provides a comprehensive set of Application Programming
Interface (API) structures and functions using an object-oriented methodology
that are implemented in C.
CONVENTIONS The SIP Stack uses specific conventions for each of the following:
 Return status codes
 Data types
 Parameters
STATUS CODES Many API functions return status codes in order to indicate the success or failure
of the requested operation. Status return values are always of the RvStatus type
as shown in Table 3-1.
Table 3-1 Status Codes
Value Meaning
RV_OK The function was completed successfully.
RV_ERROR_UNKNOWN Failure of unspecified type.
RV_ERROR_OUTOFRESOURCES The function can not be executed due to
limited resources.
RV_ERROR_BADPARAM A parameter passed to a function is illegal.