Property
[Protocol Common Services]

Detailed Description

Property APIs.


POSTAL SERVICES PROPERTY DEFINITION

Macros to Define Postal services properties.

#define ALP_POSTAL_PROPERTY(service_id, service_class_id, property_type, property_id)
#define ALP_POSTAL_PROPERTY_READ_ONLY(service_id, service_class_id, property_type, property_id)

POSTAL SERVICES PROPERTY HELPER MACROS

Macros to access properties information.

#define ALP_POSTAL_PROPERTY_GET_NUMBER(property)   (alp_postal_property_number_t)((property & ALP_POSTAL_PROPERTY_MASK_NUMBER))
 Get the property number.
#define ALP_POSTAL_PROPERTY_GET_READ_ONLY_FLAG(property)   (bool)((property & ALP_POSTAL_PROPERTY_MASK_READ_ONLY) >> 8)
 Get the property read only flag.
#define ALP_POSTAL_PROPERTY_GET_SERVICE_CLASS_ID(property)   (alp_postal_service_class_id_t)((property & ALP_POSTAL_PROPERTY_MASK_SERVICE_CLASS_ID) >> 16)
 Get the property service class identifier.
#define ALP_POSTAL_PROPERTY_GET_SERVICE_ID(property)   (alp_postal_service_id_t)((property & ALP_POSTAL_PROPERTY_MASK_SERVICE_ID) >> 24)
 Get the property service identifier.
#define ALP_POSTAL_PROPERTY_GET_TYPE(property)   (alp_postal_property_type_t)((property & ALP_POSTAL_PROPERTY_MASK_TYPE) >> 8)
 Get the property type.

POSTAL SERVICES PROPERTY MASKS

Defines properties masks.

#define ALP_POSTAL_PROPERTY_MASK_NUMBER   ((alp_postal_property_mask_t)0x000000FF)
 Number.
#define ALP_POSTAL_PROPERTY_MASK_READ_ONLY   ((alp_postal_property_mask_t)0x00008000)
 Read only.
#define ALP_POSTAL_PROPERTY_MASK_SERVICE_CLASS_ID   ((alp_postal_property_mask_t)0x00FF0000)
 Service Class Id.
#define ALP_POSTAL_PROPERTY_MASK_SERVICE_ID   ((alp_postal_property_mask_t)0xFF000000)
 Service Id.
#define ALP_POSTAL_PROPERTY_MASK_TYPE   ((alp_postal_property_mask_t)0x00007F00)
 Type Id.

POSTAL SERVICES PROPERTY TYPES

Defines properties types.

#define ALP_POSTAL_PROPERTY_TYPE_BINARY   ((alp_postal_property_type_t)1<<3)
 Binary.
#define ALP_POSTAL_PROPERTY_TYPE_BOOLEAN   ((alp_postal_property_type_t)1<<2)
 Boolean.
#define ALP_POSTAL_PROPERTY_TYPE_C_STRING   ((alp_postal_property_type_t)1<<0)
 String.
#define ALP_POSTAL_PROPERTY_TYPE_DATE   ((alp_postal_property_type_t)1<<4)
 Date.
#define ALP_POSTAL_PROPERTY_TYPE_INT   ((alp_postal_property_type_t)1<<1)
 Int.

Defines

#define ALP_POSTAL_PROPERTY_READ_ONLY_FLAG   ((alp_postal_property_type_t)1<<7)
 Property read only flag.

Typedefs

typedef const void * alp_postal_property_const_value_t
 Postal Property constant value type.
typedef uint32_t alp_postal_property_mask_t
 Postal Property mask type.
typedef uint8_t alp_postal_property_number_t
 Postal Property number type.
typedef uint8_t alp_postal_property_type_t
 Postal Property TYPE type.
typedef void * alp_postal_property_value_t
 Postal Property value type.

Functions

alp_status_t alp_postal_property_get_binary (AlpPostalProperty *iProperty, uint8_t **oBuffer, size_t *oBufferSize)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_bool (AlpPostalProperty *iProperty, bool *oBoolValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_date (AlpPostalProperty *iProperty, alp_postal_time_t *oTimeValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_int16 (AlpPostalProperty *iProperty, int16_t *oIntValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_int32 (AlpPostalProperty *iProperty, int32_t *oIntValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_int8 (AlpPostalProperty *iProperty, int8_t *oIntValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_string (AlpPostalProperty *iProperty, char **oStringValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_uint16 (AlpPostalProperty *iProperty, uint16_t *oIntValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_uint32 (AlpPostalProperty *iProperty, uint32_t *oIntValue)
 Get a Postal Property value.
alp_status_t alp_postal_property_get_uint8 (AlpPostalProperty *iProperty, uint8_t *oIntValue)
 Get a Postal Property value.

Define Documentation

#define ALP_POSTAL_PROPERTY (  service_id,
service_class_id,
property_type,
property_id   ) 
 

Value:

(alp_postal_property_id_t) \
((((alp_postal_property_id_t)service_id)<<24) \
| (((alp_postal_property_id_t)service_class_id)<<16) \
| (((alp_postal_property_id_t)property_type)<<8) \
| (((alp_postal_property_id_t)property_id)))

#define ALP_POSTAL_PROPERTY_GET_NUMBER (  property   )     (alp_postal_property_number_t)((property & ALP_POSTAL_PROPERTY_MASK_NUMBER))
 

Get the property number.

#define ALP_POSTAL_PROPERTY_GET_READ_ONLY_FLAG (  property   )     (bool)((property & ALP_POSTAL_PROPERTY_MASK_READ_ONLY) >> 8)
 

Get the property read only flag.

#define ALP_POSTAL_PROPERTY_GET_SERVICE_CLASS_ID (  property   )     (alp_postal_service_class_id_t)((property & ALP_POSTAL_PROPERTY_MASK_SERVICE_CLASS_ID) >> 16)
 

Get the property service class identifier.

#define ALP_POSTAL_PROPERTY_GET_SERVICE_ID (  property   )     (alp_postal_service_id_t)((property & ALP_POSTAL_PROPERTY_MASK_SERVICE_ID) >> 24)
 

Get the property service identifier.

#define ALP_POSTAL_PROPERTY_GET_TYPE (  property   )     (alp_postal_property_type_t)((property & ALP_POSTAL_PROPERTY_MASK_TYPE) >> 8)
 

Get the property type.

#define ALP_POSTAL_PROPERTY_MASK_NUMBER   ((alp_postal_property_mask_t)0x000000FF)
 

Number.

#define ALP_POSTAL_PROPERTY_MASK_READ_ONLY   ((alp_postal_property_mask_t)0x00008000)
 

Read only.

#define ALP_POSTAL_PROPERTY_MASK_SERVICE_CLASS_ID   ((alp_postal_property_mask_t)0x00FF0000)
 

Service Class Id.

#define ALP_POSTAL_PROPERTY_MASK_SERVICE_ID   ((alp_postal_property_mask_t)0xFF000000)
 

Service Id.

#define ALP_POSTAL_PROPERTY_MASK_TYPE   ((alp_postal_property_mask_t)0x00007F00)
 

Type Id.

#define ALP_POSTAL_PROPERTY_READ_ONLY (  service_id,
service_class_id,
property_type,
property_id   ) 
 

Value:

(alp_postal_property_id_t) \
                                  ((((alp_postal_property_id_t)service_id)<<24) \
                                  | (((alp_postal_property_id_t)service_class_id)<<16) \
                                  | (((alp_postal_property_id_t)property_type | (alp_postal_property_id_t)ALP_POSTAL_PROPERTY_READ_ONLY_FLAG)<<8) \
                                  | (((alp_postal_property_id_t)property_id)))

#define ALP_POSTAL_PROPERTY_READ_ONLY_FLAG   ((alp_postal_property_type_t)1<<7)
 

Property read only flag.

#define ALP_POSTAL_PROPERTY_TYPE_BINARY   ((alp_postal_property_type_t)1<<3)
 

Binary.

#define ALP_POSTAL_PROPERTY_TYPE_BOOLEAN   ((alp_postal_property_type_t)1<<2)
 

Boolean.

#define ALP_POSTAL_PROPERTY_TYPE_C_STRING   ((alp_postal_property_type_t)1<<0)
 

String.

#define ALP_POSTAL_PROPERTY_TYPE_DATE   ((alp_postal_property_type_t)1<<4)
 

Date.

#define ALP_POSTAL_PROPERTY_TYPE_INT   ((alp_postal_property_type_t)1<<1)
 

Int.

Typedef Documentation

typedef const void* alp_postal_property_const_value_t
 

Postal Property constant value type.

typedef uint32_t alp_postal_property_mask_t
 

Postal Property mask type.

typedef uint8_t alp_postal_property_number_t
 

Postal Property number type.

typedef uint8_t alp_postal_property_type_t
 

Postal Property TYPE type.

typedef void* alp_postal_property_value_t
 

Postal Property value type.

Function Documentation

alp_status_t alp_postal_property_get_binary (  AlpPostalProperty *  iProperty,
uint8_t **  oBuffer,
size_t *  oBufferSize
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oBuffer The retrieved value Ptr. MUST NOT be freed neither updated.
[out] oBufferSize The bufferSize.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_bool (  AlpPostalProperty *  iProperty,
bool *  oBoolValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oBoolValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_date (  AlpPostalProperty *  iProperty,
alp_postal_time_t *  oTimeValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oTimeValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_int16 (  AlpPostalProperty *  iProperty,
int16_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_int32 (  AlpPostalProperty *  iProperty,
int32_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_int8 (  AlpPostalProperty *  iProperty,
int8_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_string (  AlpPostalProperty *  iProperty,
char **  oStringValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oStringValue The retrieved value Ptr. MUST NOT be freed neither updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_uint16 (  AlpPostalProperty *  iProperty,
uint16_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_uint32 (  AlpPostalProperty *  iProperty,
uint32_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

alp_status_t alp_postal_property_get_uint8 (  AlpPostalProperty *  iProperty,
uint8_t *  oIntValue
) 
 

Get a Postal Property value.

Parameters:
[in] iProperty The Property Ptr where to get the value.
[out] oIntValue The retrieved value. MUST NOT be updated.
Returns:
Returns an error code.

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.