SystemMessage
[IMPS]

Detailed Description

Postal IMPS system messages APIs.


Data Structures

struct  _AlpPostalImpsSystemMessage
 Postal IMPS System Message. More...
struct  _AlpPostalImpsSystemMessageList
 a linked list of PostalProperties. More...

Defines

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_INT, 7)
 System Message Answer ID.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_OPTION   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 6)
 System Message Answer (True if list present).
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 8)
 System Message Answer Text.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 System Message ID.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_REQUIRE_RESPONSE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 2)
 System Message Require Response.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 System Message Text.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_VERIFICATION_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 System Message Verification Text.
#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_VERIFICATION_URL   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 5)
 System Message Verification URL.

Typedefs

typedef _AlpPostalImpsSystemMessage AlpPostalImpsSystemMessage
 Postal IMPS System Message.
typedef _AlpPostalPropertyContainer AlpPostalImpsSystemMessageAnswer
 Defines IMPS System Message Option Address.
typedef _AlpPostalPropertyContainerList AlpPostalImpsSystemMessageAnswerList
typedef _AlpPostalImpsSystemMessageList AlpPostalImpsSystemMessageList
 Postal IMPS System Message List.
typedef _AlpPostalPropertyContainer AlpPostalImpsSystemMessageResponse
 Postal IMPS System Message Response.
typedef _AlpPostalPropertyContainerList AlpPostalImpsSystemMessageResponseList
 Postal IMPS System Message List.

Functions

alp_status_t alp_postal_imps_system_message_free (AlpPostalImpsSystemMessage *iImpsSystemMessage)
 Free a SystemMessage. Also free the Answers that belong to it.
alp_status_t alp_postal_imps_system_message_response_add_to_list (AlpPostalImpsSystemMessageResponseList *iImpsResponseList, AlpPostalImpsSystemMessageResponse *iImpsResponse)
 Append a AlpPostalImpsSystemMessageResponse to a AlpPostalImpsSystemMessageResponseList.
alp_status_t alp_postal_imps_system_message_response_get_property (AlpPostalImpsSystemMessageResponse *iImpsResponse, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oImpsResponsePropertyP)
 Get a property from a AlpPostalImpsSystemMessageResponse.
alp_status_t alp_postal_imps_system_message_response_init (AlpPostalImpsSystemMessageResponse *iImpsResponse)
 Initialize a SystemMessageResponse. MUST be called before used.
alp_status_t alp_postal_imps_system_message_response_list_free (AlpPostalImpsSystemMessageResponseList *iImpsResponseList)
 Free a SystemMessageResponseList. Also free the responses that belong to it.
alp_status_t alp_postal_imps_system_message_response_list_init (AlpPostalImpsSystemMessageResponseList *iImpsResponseList)
 Initialize a SystemMessageResponseList. MUST be called before used.
alp_status_t alp_postal_imps_system_message_response_set_property (AlpPostalImpsSystemMessageResponse *ioImpsResponse, alp_postal_property_id_t iImpsResponsePropertyId, alp_postal_property_const_value_t iImpsResponsePropertyDataP, uint16_t iImpsResponsePropertyDataSize)
 Set a property on a AlpPostalImpsSystemMessageResponse.

Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_INT, 7)
 

System Message Answer ID.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_OPTION   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 6)
 

System Message Answer (True if list present).

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ANSWER_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 8)
 

System Message Answer Text.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

System Message ID.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_REQUIRE_RESPONSE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 2)
 

System Message Require Response.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 

System Message Text.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_VERIFICATION_TEXT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 

System Message Verification Text.

#define ALP_POSTAL_IMPS_PROPERTY_SYSTEM_MESSAGE_VERIFICATION_URL   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_SYSTEM_MESSAGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 5)
 

System Message Verification URL.

Typedef Documentation

typedef struct _AlpPostalImpsSystemMessage AlpPostalImpsSystemMessage
 

Postal IMPS System Message.

typedef struct _AlpPostalPropertyContainer AlpPostalImpsSystemMessageAnswer
 

Defines IMPS System Message Option Address.

typedef struct _AlpPostalPropertyContainerList AlpPostalImpsSystemMessageAnswerList
 

typedef struct _AlpPostalImpsSystemMessageList AlpPostalImpsSystemMessageList
 

Postal IMPS System Message List.

typedef struct _AlpPostalPropertyContainer AlpPostalImpsSystemMessageResponse
 

Postal IMPS System Message Response.

typedef struct _AlpPostalPropertyContainerList AlpPostalImpsSystemMessageResponseList
 

Postal IMPS System Message List.

Function Documentation

alp_status_t alp_postal_imps_system_message_free (  AlpPostalImpsSystemMessage *  iImpsSystemMessage  ) 
 

Free a SystemMessage. Also free the Answers that belong to it.

Parameters:
[in] iImpsSystemMessage A SystemMessage to free.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_add_to_list (  AlpPostalImpsSystemMessageResponseList *  iImpsResponseList,
AlpPostalImpsSystemMessageResponse *  iImpsResponse
) 
 

Append a AlpPostalImpsSystemMessageResponse to a AlpPostalImpsSystemMessageResponseList.

Parameters:
[in] iImpsResponseList A response list Ptr.
[in] iImpsResponse A response to add.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_get_property (  AlpPostalImpsSystemMessageResponse *  iImpsResponse,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oImpsResponsePropertyP
) 
 

Get a property from a AlpPostalImpsSystemMessageResponse.

Parameters:
[in] iImpsResponse A contact Ptr.
[in] iPropertyId A Property ID.
[out] oImpsResponsePropertyP A system message response property to retrieve.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_init (  AlpPostalImpsSystemMessageResponse *  iImpsResponse  ) 
 

Initialize a SystemMessageResponse. MUST be called before used.

Parameters:
[in] iImpsResponse A response message to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_list_free (  AlpPostalImpsSystemMessageResponseList *  iImpsResponseList  ) 
 

Free a SystemMessageResponseList. Also free the responses that belong to it.

Parameters:
[in] iImpsResponseList A ResponseList to free.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_list_init (  AlpPostalImpsSystemMessageResponseList *  iImpsResponseList  ) 
 

Initialize a SystemMessageResponseList. MUST be called before used.

Parameters:
[in] iImpsResponseList A NickList to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_system_message_response_set_property (  AlpPostalImpsSystemMessageResponse *  ioImpsResponse,
alp_postal_property_id_t  iImpsResponsePropertyId,
alp_postal_property_const_value_t  iImpsResponsePropertyDataP,
uint16_t  iImpsResponsePropertyDataSize
) 
 

Set a property on a AlpPostalImpsSystemMessageResponse.

Parameters:
[in,out] ioImpsResponse The Postal ImpsContact in which a property must be set.
[in] iImpsResponsePropertyId The Id of the property to be created.
[in] iImpsResponsePropertyDataP The value of the property to be created.
[in] iImpsResponsePropertyDataSize the size of the data
Returns:
Returns an error code.

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

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