Definitions common to more than one external module API. More...

Files
file	ripapiversn.h
	This header file provides definitions of the versions of the pervasive RDR-discoverable APIs used by this core RIP build.

file	swapi.h
	Header file defining Core module interface definitions.

Data Structures
struct	sw_api_info
	Required first member for all APIs. More...

Typedefs
typedef HqnResult	sw_api_result
	Result type for SwRegister* calls. More...

typedef uint32	sw_api_version
	Type for interface version numbers.

typedef struct sw_api_info	sw_api_info
	Required first member for all APIs.

Enumerations
enum	SWAPI_RESULT { SW_API_REGISTERED = HQN_RESULT_SUCCESS , SW_API_ERROR , SW_API_NOT_UNIQUE , SW_API_NOT_AUTHORISED , SW_API_VERSION_TOO_OLD , SW_API_VERSION_TOO_NEW , SW_API_BAD_UNICODE , SW_API_INCOMPLETE , SW_API_INSTANCE_SIZE , SW_API_INVALID , SW_API_TOO_EARLY , SW_API_INIT_FAILED }
	Return values for common for all SwRegister* calls. More...

Functions
HqnResult	swapi_result_translate (sw_api_result result)
	Translate a SWAPI-specific error code to a generic HqnResult error code. More...

Detailed Description

Definitions common to more than one external module API.

Typedef Documentation

◆ sw_api_result

typedef HqnResult sw_api_result

Result type for SwRegister* calls.

This is a subclass of HqnResult that also supports some specific extra error codes generated by SwRegister* (declared as the SWAPI_RESULT enumeration). Before assigning to values of HqnResult type or any of its other subclasses, sw_api_result values must be converted to change the SwRegister* specific values to HQN_RESULT_SUCCESS or a monitor UID error code greater than MON_CLASS_ERROR. This can be done by calling the function swapi_result_translate().

Enumeration Type Documentation

◆ SWAPI_RESULT

enum SWAPI_RESULT

Return values for common for all SwRegister* calls.

Enumerator
SW_API_REGISTERED	Module instance successfully registered.
SW_API_ERROR	Non-specific error during registration.
SW_API_NOT_UNIQUE	Module instance name is not unique.
SW_API_NOT_AUTHORISED	Instance is not authorised to register.
SW_API_VERSION_TOO_OLD	Interface version is too old for RIP.
SW_API_VERSION_TOO_NEW	Interface version is too new for RIP.
SW_API_BAD_UNICODE	Module's display name is not valid UTF-8.
SW_API_INCOMPLETE	A required entry is incorrect (e.g., a requird method function pointer is `NULL`.)
SW_API_INSTANCE_SIZE	The instance size is too small for the version.
SW_API_INVALID	An entry has an invalid value.
SW_API_TOO_EARLY	SwInit() has not been called yet.
SW_API_INIT_FAILED	Initialisation of the module failed. Note Not all SwRegister*() functions invoke the init method. In some cases the init method call is deferred until the first use of the module.

Function Documentation

◆ swapi_result_translate()

HqnResult swapi_result_translate ( sw_api_result result )

Translate a SWAPI-specific error code to a generic HqnResult error code.

Parameters

[in] result One of the SWAPI_RESULT values, or an error value greater than MON_CLASS_ERROR.

Returns: Either HQN_RESULT_SUCCESS, or an error value greater than MON_CLASS_ERROR.

Files

Data Structures

Typedefs

Enumerations