include/alp/postal_bodypart.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright (c) 1999-2008 ACCESS CO., LTD. All rights reserved.
 * Copyright (c) 2006 PalmSource, Inc (an ACCESS company). All rights reserved.
 *****************************************************************************/
#ifndef ALP_POSTAL_BODYPART_H
#define ALP_POSTAL_BODYPART_H

/******************************************************************************
 * Includes
 *****************************************************************************/

#include <alp/postal_types.h>
#include <alp/postal_property.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/******************************************************************************
 * Structure
 *****************************************************************************/

typedef struct _AlpPostalPropertyContainer AlpPostalBodypart;

typedef struct _AlpPostalPropertyContainer AlpPostalBodyPartContainer;

typedef struct _AlpPostalPropertyContainerList AlpPostalBodyPartContainerList;

/******************************************************************************
 * Type definition
 *****************************************************************************/

typedef alp_postal_object_id_t alp_postal_bodypart_id_t;

#define ALP_POSTAL_BODYPART_INVALID_ID                  ((alp_postal_bodypart_id_t)ALP_POSTAL_INVALID_OBJECT_ID)

#define ALP_POSTAL_BODYPART_NO_PARENT                   ((alp_postal_bodypart_part_no_t)0)

#define ALP_POSTAL_BODYPART_INVALID_PART_NO             ((alp_postal_bodypart_part_no_t)0)
#define ALP_POSTAL_BODYPART_INVALID_ORDINAL_NO  ((alp_postal_bodypart_ordinal_no_t)0)

typedef uint16_t alp_postal_bodypart_part_no_t;
typedef uint16_t alp_postal_bodypart_ordinal_no_t;

#define ALP_POSTAL_PROPERTY_BODYPART_URI \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)

#define ALP_POSTAL_PROPERTY_BODYPART_SIZE \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 2)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_DESCRIPTION \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TYPE \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)

#define ALP_POSTAL_PROPERTY_BODYPART_DISPOSITION \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 5)

#define ALP_POSTAL_PROPERTY_BODYPART_NAME \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 6)

#define ALP_POSTAL_PROPERTY_BODYPART_SMALL_CONTENT \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 7)

#define ALP_POSTAL_PROPERTY_BODYPART_HEADER     \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 8)

#define ALP_POSTAL_PROPERTY_BODYPART_PART_NO \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 9)

#define ALP_POSTAL_PROPERTY_BODYPART_HAS_CHILD \
                                ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 10)

#define ALP_POSTAL_PROPERTY_BODYPART_SMALL_CONTENT_BINARY \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_BINARY, 11)

#define ALP_POSTAL_PROPERTY_BODYPART_TYPE \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 12)

#define ALP_POSTAL_PROPERTY_BODYPART_ORDINAL_NO \
                                ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 13)

#define ALP_POSTAL_PROPERTY_BODYPART_PARENT_NO \
                                ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 14)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TYPE_CHARSET \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 15)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_DISPOSITION_FILENAME \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 16)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_DISPOSITION_FILENAME_NATIVE_CHARSET \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 17)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TYPE_NAME \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 18)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TYPE_NAME_NATIVE_CHARSET \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 19)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TRANSFER_ENCODING \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 20)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_ID \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 21)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_LOCATION \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 22)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_NATIVE_CHARSET \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 23)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_STATUS \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 24)

#define ALP_POSTAL_PROPERTY_BODYPART_CONTENT_TYPE_REPORT_TYPE \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 25)

#define ALP_POSTAL_PROPERTY_BODYPART_URI_DESCRIPTOR \
                                ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_BODYPART, ALP_POSTAL_PROPERTY_TYPE_INT, 26)
/* @} */


typedef uint8_t  alp_postal_bodypart_disposition_t;

#define ALP_POSTAL_BODYPART_DISPOSITION_INLINE                          ((alp_postal_bodypart_disposition_t)1)

#define ALP_POSTAL_BODYPART_DISPOSITION_ATTACHMENT                      ((alp_postal_bodypart_disposition_t)2)
/* @} */

typedef uint8_t  alp_postal_bodypart_type_t;

#define ALP_POSTAL_BODYPART_TYPE_SMALL_TEXT                             ((alp_postal_bodypart_type_t)1)

#define ALP_POSTAL_BODYPART_TYPE_SMALL_BINARY                           ((alp_postal_bodypart_type_t)2)

#define ALP_POSTAL_BODYPART_TYPE_URI                                    ((alp_postal_bodypart_type_t)3)

#define ALP_POSTAL_BODYPART_TYPE_MULTIPART                              ((alp_postal_bodypart_type_t)4)
/* @} */


#define ALP_POSTAL_BODYPART_TYPE_SMALL_TEXT_MAX_SIZE    4096

#define ALP_POSTAL_BODYPART_TYPE_SMALL_BINARY_MAX_SIZE  4096
/* @} */

#define ALP_POSTAL_BODYPART_URI_PROPERTY_MAX_LENGTH             512
/* @} */

typedef uint8_t  alp_postal_bodypart_content_status_t;

#define ALP_POSTAL_BODYPART_CONTENT_STATUS_COMPLETE                             ((alp_postal_bodypart_content_status_t)1)

#define ALP_POSTAL_BODYPART_CONTENT_STATUS_QUITED                               ((alp_postal_bodypart_content_status_t)2)

#define ALP_POSTAL_BODYPART_CONTENT_STATUS_TOOBIG                               ((alp_postal_bodypart_content_status_t)3)
/* @} */

typedef uint8_t  alp_postal_bodypart_clone_method_t;

#define ALP_POSTAL_BODYPART_CLONE_ONE           ((alp_postal_bodypart_clone_method_t)1)

#define ALP_POSTAL_BODYPART_CLONE_CHILDREN      ((alp_postal_bodypart_clone_method_t)2)

#define ALP_POSTAL_BODYPART_CLONE_ALL           ((alp_postal_bodypart_clone_method_t)3)
/* @} */


/******************************************************************************
 * Prototypes
 *****************************************************************************/

alp_status_t alp_postal_bodypart_init(AlpPostalBodypart* iBodypartP);

alp_status_t alp_postal_bodypart_init_container_list(AlpPostalBodyPartContainerList* iBodypartCLP);

alp_status_t    alp_postal_bodypart_set_property(AlpPostalBodypart* ioBodypartP, alp_postal_property_id_t iBodypartPropertyId, alp_postal_property_const_value_t iBodypartPropertyDataP, uint16_t iBodypartPropertyDataSize);

alp_status_t    alp_postal_bodypart_get_property(AlpPostalBodypart* iBodypartP, alp_postal_property_id_t iPropertyId, AlpPostalProperty** oBodypartPropertyP);

alp_status_t    alp_postal_bodypart_add_bodypart(AlpPostalBodyPartContainerList* iContainerListP, AlpPostalBodypart* iBodypartP);

alp_status_t    alp_postal_bodypart_add_container(AlpPostalBodyPartContainerList* iContainerListP1, AlpPostalBodyPartContainerList* iContainerListP2, AlpPostalBodypart* iCompositeBodypartP);

alp_status_t    alp_postal_bodypart_get_next(AlpPostalBodypart* iBodypart, AlpPostalBodypart** oNextBodypart);

alp_status_t    alp_postal_bodypart_get_child(AlpPostalBodypart* iBodypart, AlpPostalBodypart** oChildBodypart);

alp_status_t    alp_postal_bodypart_is_composite(AlpPostalBodypart* iBodypart, bool* oIsComposite);

alp_status_t    alp_postal_bodypart_clone(const AlpPostalBodypart* iBodypart, AlpPostalBodypart* oBodypart, alp_postal_bodypart_clone_method_t iCloneMethod);

alp_status_t    alp_postal_bodypart_free(AlpPostalBodypart* iBodypartP);


#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* ALP_POSTAL_BODYPART_H */

---

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

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