Typedefs | Enumerations

API Error Return Codes

Typedefs

typedef enum HWAPI_RESULT HWAPI_RESULT
 Hex Workshop Plug-in API Error Definitions.

Enumerations

enum  HWAPI_RESULT {
  HWAPI_RESULT_SUCCESS = 0x00000000, HWAPI_RESULT_OUTOFRANGE = 0x80000001, HWAPI_RESULT_CLOSED_DOCUMENT = 0x80000002, HWAPI_RESULT_INVALID_HWDOCUMENT = 0x80000003,
  HWAPI_RESULT_INVALID_HWSESSION = 0x80000004, HWAPI_RESULT_INVALID_PARAMETER = 0x80000005, HWAPI_RESULT_NOT_IMPLEMENTED = 0x80000006, HWAPI_RESULT_BUFFER_TOO_SMALL = 0x80000007,
  HWAPI_RESULT_USER_ABORT = 0x80000008, HWAPI_RESULT_FAILED = 0x80000009, HWAPI_RESULT_NOT_FOUND = 0x8000000A, HWAPI_RESULT_INTERNAL_ERROR = 0xFFFFFFFF
}
 

Hex Workshop Plug-in API Error Definitions.

More...

Typedef Documentation

typedef enum HWAPI_RESULT HWAPI_RESULT

hwapierr.h defines the Hex Workshop Plug-in error return codes for functions defined in hwapi.h Hex Workshop Plug-in API return codes

HWAPI_RESULT_SUCCESS (0) is return for a successful operations, otherwise the operation failed and the return code indicates the failure cause.


Enumeration Type Documentation

hwapierr.h defines the Hex Workshop Plug-in error return codes for functions defined in hwapi.h Hex Workshop Plug-in API return codes

HWAPI_RESULT_SUCCESS (0) is return for a successful operations, otherwise the operation failed and the return code indicates the failure cause.

Enumerator:
HWAPI_RESULT_SUCCESS 

Success; no errors

HWAPI_RESULT_OUTOFRANGE 

An offset, index or length is out of bounds

HWAPI_RESULT_CLOSED_DOCUMENT 

Cannot operate on a closed document

HWAPI_RESULT_INVALID_HWDOCUMENT 

The HWDOCUMENT handle is not valid

HWAPI_RESULT_INVALID_HWSESSION 

The HWSESSION handle is not valid

HWAPI_RESULT_INVALID_PARAMETER 

An invalid parameter was passed to this API

HWAPI_RESULT_NOT_IMPLEMENTED 

The api method has not yet been implemented

HWAPI_RESULT_BUFFER_TOO_SMALL 

The supplied buffer it too small for the operation

HWAPI_RESULT_USER_ABORT 

The user aborted the operation

HWAPI_RESULT_FAILED 

The operation failed

HWAPI_RESULT_NOT_FOUND 

Unable to find requested resource

HWAPI_RESULT_INTERNAL_ERROR 

An internal unexpected error occured

Definition at line 32 of file hwapierr.h.


Copyright © 2010 BreakPoint Software, Inc. All Right Reserved.
Generated on Sat Jan 1 2011 07:53:51 for Hex Workshop Plug-in API by doxygen 1.7.2