Aggregate Property

The entire address.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetAggregate();
int SetAggregate(const char* lpszAggregate);

Unicode (Windows)
LPWSTR GetAggregate();
INT SetAggregate(LPCWSTR lpszAggregate);

@property (nonatomic,readwrite,assign,getter=aggregate,setter=setAggregate:) NSString* aggregate;
- (NSString*)aggregate;
- (void)setAggregate:(NSString*)newAggregate;

#define PID_ADDRESS_AGGREGATE 1

INQB_EXTERNAL void* INQB_CALL InQB_Address_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
INQB_EXTERNAL int INQB_CALL InQB_Address_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

An aggregate consisting of the entire address, formatted as XML without end tags. Address properties of the various classs accept and return data in this format exclusively.

When this property is read, an aggregate is formed from the value of all the other properties. When the property is written, the input is parsed and the various properties are set. Reading or writing the value of this property will also escape or unescape special characters such as '&', as appropriate.

There is generally no need to generate or inspect the value of Aggregate by hand. This property allows the user to easily pass data between instances of an Address class, or between an Address class and a QuickBooks object class.

It is, however, possible, to generate the value by hand, and use this value directly in other classs as an alternative to using the Address class. The formatting is as in QBXML; any or all fields may be left out:

<Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

Data Type

String