Errors
[Protocol Common Services]

---

Detailed Description

Common Postal Errors.

POSTAL ERRORS MACROS
Helper Macros to deal with the postal errors.
#define	ALP_POSTAL_ERROR_DECLARE(sys_class_id, error_id)   ((alp_status_t)((alp_status_t)(sys_class_id) | (alp_status_t)(error_id) << 16))
	Define a postal error. For plugin developers only.
#define	ALP_POSTAL_ERROR_INFO(error)   ((alp_status_t)(error) & 0x0000FFFF)
	Get the error info part.
#define	ALP_POSTAL_ERROR_SET_INFO(postal_status, status_info)   (alp_status_t)(((alp_status_t)(postal_status))| ((((alp_status_t)(status_info)) >> 16) & 0x0000FFFF))
	Set the postal error info part. For plugin developers only.
#define	ALP_POSTAL_ERROR_VALUE(error)   ((alp_status_t)(error) & 0xFFFF0000)
	Get the error value part.
POSTAL ERRORS
Defines the postal common errors. A localized text describing the error can be retrieved or displayed in a dialog box to the user, by using the ALP Error Manager APIs.
#define	POSTAL_STATUS_ACCOUNT_NAME_ALREADY_EXISTS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x20)
	An account with this name already exists.
#define	POSTAL_STATUS_ADDRESS_ALREADY_EXIST   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x24)
	Adding an address to a list that already has it.
#define	POSTAL_STATUS_ALREADY_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x12)
	The session connection has already been done.
#define	POSTAL_STATUS_BUSY   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x21)
	Some operations can't be called by several client at the same time.
#define	POSTAL_STATUS_CANCEL_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x10)
	Asynchronous function cancel return an error.
#define	POSTAL_STATUS_CANCEL_FAILED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1C)
	Cancel synchronous API failed.
#define	POSTAL_STATUS_COM_DNS_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1D)
	Retrieve DNS failed.
#define	POSTAL_STATUS_COM_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0A)
	Com layer return an error.
#define	POSTAL_STATUS_DB_BAD_PARAM   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0D)
	DB Layer return an error.
#define	POSTAL_STATUS_DB_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0C)
	DB Layer return an error.
#define	POSTAL_STATUS_DB_FULL   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x15)
	The Database is full.
#define	POSTAL_STATUS_DB_NO_RECORD   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0E)
	DB Layer return an error.
#define	POSTAL_STATUS_ENVELOPE_LOCKED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x22)
	The ENVELOPE is locking it.
#define	POSTAL_STATUS_ENVELOPE_PROTECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1F)
	Envelope is protected.
#define	POSTAL_STATUS_FOLDER_NAME_ALREADY_EXIST   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x28)
	A folder with the same name already exists.
#define	POSTAL_STATUS_IN_PROGRESS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1A)
	Operation in progress.
#define	POSTAL_STATUS_INDEX_OUT_OF_RANGE   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1E)
	list index out of range.
#define	POSTAL_STATUS_INVALID_PARAM   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0B)
	Invalid Param.
#define	POSTAL_STATUS_IO_SLEEP   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x05)
	Can sleep. (for internal use only).
#define	POSTAL_STATUS_IPC_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x03)
	IPC error.
#define	POSTAL_STATUS_MEMORY_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x06)
	Memory allocation error.
#define	POSTAL_STATUS_NO_PROV_SETTINGS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x23)
	Provisioned settings not available.
#define	POSTAL_STATUS_NOT_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x11)
	The session connection has not been done.
#define	POSTAL_STATUS_NOT_FOUND   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0F)
	Not Found.
#define	POSTAL_STATUS_OK   ALP_STATUS_OK
	No error.
#define	POSTAL_STATUS_PERMISSION_DENIED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1B)
	Security permission denied.
#define	POSTAL_STATUS_PROPERTY_READ_ONLY   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x18)
	The property is read only and can not be set.
#define	POSTAL_STATUS_RULE_CONFLICT   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x27)
	The rule cannot be saved due to a conflicting record already saved.
#define	POSTAL_STATUS_SERVICE_CALL_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x08)
	Service load/unload/init error.
#define	POSTAL_STATUS_SERVICE_NOT_FOUND_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x09)
	Service does not exist.
#define	POSTAL_STATUS_SESSION_ALREADY_CREATED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x14)
	The session is already created.
#define	POSTAL_STATUS_SESSION_AUTH_FAILED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x19)
	One of the credential is invalid.
#define	POSTAL_STATUS_SESSION_INVALID_ACCOUNT_DATA   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x25)
	The account data are invalid(ex: It is over the limiting value of the length of a character string).
#define	POSTAL_STATUS_SESSION_INVALID_FOLDER_DATA   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x26)
	The folder data are invalid(ex: It is over the limiting value of the length of a character string).
#define	POSTAL_STATUS_SESSION_INVALID_PASSWORD   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x16)
	The password is invalid.
#define	POSTAL_STATUS_SESSION_NOT_CREATED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x13)
	The session is not created.
#define	POSTAL_STATUS_SESSION_STILL_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x17)
	The must be closed before it can be deleted.
#define	POSTAL_STATUS_TIME_OUT   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x02)
	Time out.
#define	POSTAL_STATUS_TYPE_MISMATCH   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x07)
	A property that is not of the right class or not in range is added to a postal object structure.
#define	POSTAL_STATUS_UNKNOWN   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x01)
	Unknown error.
#define	POSTAL_STATUS_WOULD_BLOCK   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x04)
	Can be called continuously. (for internal use only).

---

Define Documentation

#define ALP_POSTAL_ERROR_DECLARE (  sys_class_id, error_id   )     ((alp_status_t)((alp_status_t)(sys_class_id) | (alp_status_t)(error_id) << 16))

Define a postal error. For plugin developers only.

#define ALP_POSTAL_ERROR_INFO (  error   )     ((alp_status_t)(error) & 0x0000FFFF)

Get the error info part.

#define ALP_POSTAL_ERROR_SET_INFO (  postal_status, status_info   )     (alp_status_t)(((alp_status_t)(postal_status))| ((((alp_status_t)(status_info)) >> 16) & 0x0000FFFF))

Set the postal error info part. For plugin developers only.

#define ALP_POSTAL_ERROR_VALUE (  error   )     ((alp_status_t)(error) & 0xFFFF0000)

Get the error value part.

#define POSTAL_STATUS_ACCOUNT_NAME_ALREADY_EXISTS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x20)

An account with this name already exists.

#define POSTAL_STATUS_ADDRESS_ALREADY_EXIST   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x24)

Adding an address to a list that already has it.

#define POSTAL_STATUS_ALREADY_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x12)

The session connection has already been done.

#define POSTAL_STATUS_BUSY   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x21)

Some operations can't be called by several client at the same time.

#define POSTAL_STATUS_CANCEL_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x10)

Asynchronous function cancel return an error.

#define POSTAL_STATUS_CANCEL_FAILED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1C)

Cancel synchronous API failed.

#define POSTAL_STATUS_COM_DNS_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1D)

Retrieve DNS failed.

#define POSTAL_STATUS_COM_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0A)

Com layer return an error.

#define POSTAL_STATUS_DB_BAD_PARAM   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0D)

DB Layer return an error.

#define POSTAL_STATUS_DB_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0C)

DB Layer return an error.

#define POSTAL_STATUS_DB_FULL   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x15)

The Database is full.

#define POSTAL_STATUS_DB_NO_RECORD   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0E)

DB Layer return an error.

#define POSTAL_STATUS_ENVELOPE_LOCKED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x22)

The ENVELOPE is locking it.

#define POSTAL_STATUS_ENVELOPE_PROTECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1F)

Envelope is protected.

#define POSTAL_STATUS_FOLDER_NAME_ALREADY_EXIST   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x28)

A folder with the same name already exists.

#define POSTAL_STATUS_IN_PROGRESS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1A)

Operation in progress.

#define POSTAL_STATUS_INDEX_OUT_OF_RANGE   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1E)

list index out of range.

#define POSTAL_STATUS_INVALID_PARAM   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0B)

Invalid Param.

#define POSTAL_STATUS_IO_SLEEP   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x05)

Can sleep. (for internal use only).

#define POSTAL_STATUS_IPC_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x03)

IPC error.

#define POSTAL_STATUS_MEMORY_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x06)

Memory allocation error.

#define POSTAL_STATUS_NO_PROV_SETTINGS   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x23)

Provisioned settings not available.

#define POSTAL_STATUS_NOT_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x11)

The session connection has not been done.

#define POSTAL_STATUS_NOT_FOUND   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x0F)

Not Found.

#define POSTAL_STATUS_OK   ALP_STATUS_OK

No error.

#define POSTAL_STATUS_PERMISSION_DENIED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x1B)

Security permission denied.

#define POSTAL_STATUS_PROPERTY_READ_ONLY   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x18)

The property is read only and can not be set.

#define POSTAL_STATUS_RULE_CONFLICT   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x27)

The rule cannot be saved due to a conflicting record already saved.

#define POSTAL_STATUS_SERVICE_CALL_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x08)

Service load/unload/init error.

#define POSTAL_STATUS_SERVICE_NOT_FOUND_ERROR   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x09)

Service does not exist.

#define POSTAL_STATUS_SESSION_ALREADY_CREATED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x14)

The session is already created.

#define POSTAL_STATUS_SESSION_AUTH_FAILED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x19)

One of the credential is invalid.

#define POSTAL_STATUS_SESSION_INVALID_ACCOUNT_DATA   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x25)

The account data are invalid(ex: It is over the limiting value of the length of a character string).

#define POSTAL_STATUS_SESSION_INVALID_FOLDER_DATA   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x26)

The folder data are invalid(ex: It is over the limiting value of the length of a character string).

#define POSTAL_STATUS_SESSION_INVALID_PASSWORD   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x16)

The password is invalid.

#define POSTAL_STATUS_SESSION_NOT_CREATED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x13)

The session is not created.

#define POSTAL_STATUS_SESSION_STILL_CONNECTED   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x17)

The must be closed before it can be deleted.

#define POSTAL_STATUS_TIME_OUT   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x02)

Time out.

#define POSTAL_STATUS_TYPE_MISMATCH   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x07)

A property that is not of the right class or not in range is added to a postal object structure.

#define POSTAL_STATUS_UNKNOWN   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x01)

Unknown error.

#define POSTAL_STATUS_WOULD_BLOCK   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_POSTAL, 0x04)

Can be called continuously. (for internal use only).

---

Generated on Wed Jul 30 07:06:43 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.