PublicProfile
[IMPS]


Detailed Description

Postal IMPS Public Profile APIs.


Defines

#define ALP_POSTAL_IMPS_PROPERTY_PP_AGE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 Public Profile AGE.
#define ALP_POSTAL_IMPS_PROPERTY_PP_COUNTRY   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 Public Profile COUNTRY.
#define ALP_POSTAL_IMPS_PROPERTY_PP_FRIENDLY_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 Public Profile FRIENDLY NAME.
#define ALP_POSTAL_IMPS_PROPERTY_PP_USER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 Public Profile USER_ID.

Typedefs

typedef _AlpPostalPropertyContainer AlpPostalImpsPublicProfile
 Defines IMPS Public Profile.
typedef _AlpPostalPropertyContainerList AlpPostalImpsPublicProfileList
 Defines IMPS Public Profile List.

Functions

alp_status_t alp_postal_imps_public_profile_free (AlpPostalImpsPublicProfile *iImpsPublicProfile)
 Free a PublicProfile.
alp_status_t alp_postal_imps_public_profile_get_property (AlpPostalImpsPublicProfile *iImpsPublicProfile, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oImpsPublicProfilePropertyP)
 Get a property from a AlpPostalImpsPublicProfile.
alp_status_t alp_postal_imps_public_profile_init (AlpPostalImpsPublicProfile *iImpsPublicProfile)
 Initialize a PublicProfile. MUST be called before used.
alp_status_t alp_postal_imps_public_profile_set_property (AlpPostalImpsPublicProfile *ioImpsPublicProfile, alp_postal_property_id_t iImpsPublicProfilePropertyId, alp_postal_property_const_value_t iImpsPublicProfilePropertyDataP, uint16_t iImpsPublicProfilePropertyDataSize)
 Set a property on a AlpPostalImpsPublicProfile.


Define Documentation

#define ALP_POSTAL_IMPS_PROPERTY_PP_AGE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

Public Profile AGE.

#define ALP_POSTAL_IMPS_PROPERTY_PP_COUNTRY   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 

Public Profile COUNTRY.

#define ALP_POSTAL_IMPS_PROPERTY_PP_FRIENDLY_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 

Public Profile FRIENDLY NAME.

#define ALP_POSTAL_IMPS_PROPERTY_PP_USER_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_IMPS, ALP_POSTAL_IMPS_SERVICE_CLASS_ID_PUBLIC_PROFILE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

Public Profile USER_ID.


Typedef Documentation

typedef struct _AlpPostalPropertyContainer AlpPostalImpsPublicProfile
 

Defines IMPS Public Profile.

typedef struct _AlpPostalPropertyContainerList AlpPostalImpsPublicProfileList
 

Defines IMPS Public Profile List.


Function Documentation

alp_status_t alp_postal_imps_public_profile_free AlpPostalImpsPublicProfile iImpsPublicProfile  ) 
 

Free a PublicProfile.

Parameters:
[in] iImpsPublicProfile A PublicProfile to free.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_public_profile_get_property AlpPostalImpsPublicProfile iImpsPublicProfile,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oImpsPublicProfilePropertyP
 

Get a property from a AlpPostalImpsPublicProfile.

Parameters:
[in] iImpsPublicProfile A PublicProfile Ptr.
[in] iPropertyId A Property ID.
[out] oImpsPublicProfilePropertyP A Public Profile response property to retrieve.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_public_profile_init AlpPostalImpsPublicProfile iImpsPublicProfile  ) 
 

Initialize a PublicProfile. MUST be called before used.

Parameters:
[in] iImpsPublicProfile A PublicProfile to initialize.
Returns:
Returns an error code.

alp_status_t alp_postal_imps_public_profile_set_property AlpPostalImpsPublicProfile ioImpsPublicProfile,
alp_postal_property_id_t  iImpsPublicProfilePropertyId,
alp_postal_property_const_value_t  iImpsPublicProfilePropertyDataP,
uint16_t  iImpsPublicProfilePropertyDataSize
 

Set a property on a AlpPostalImpsPublicProfile.

Parameters:
[in,out] ioImpsPublicProfile The Postal PublicProfile in which a property must be set.
[in] iImpsPublicProfilePropertyId The Id of the property to be created.
[in] iImpsPublicProfilePropertyDataP The value of the property to be created.
[in] iImpsPublicProfilePropertyDataSize 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.