GetAddressCardProperties

The GetAddressCardProperties function opens an address card and retrieves its properties.

Syntax

BOOL GetAddressCardProperties(PEGOID oidCard, AddressCard *pac, int numRequestedProps, HHPRTAG *rghhProp);

At a Glance

Header file: Addrstor.h
Platforms: H/PC
Versions: 1.0 and later

Parameters

oidCard
Object identifier of the address card the properties are retrieved from.
pac
Pointer to an AddressCard structure that receives the address card's properties.
numRequestedProps
Number of property tags in the array pointed to by the rghhProp parameter.
rghhProp
Pointer to an array of property tags that identify the address card properties to retrieve. Property tags begin with an HHPR_ prefix. For a list of property tags, see Contacts Database.

Return Values

Returns TRUE if the function succeeds, or FALSE otherwise.

Remarks

The system allocates memory for the address card's properties. After every call to the GetAddressCardProperties function, an application must free the memory by calling the FreeAddressCard function.

If only a few properties from the address card need to be displayed, calling GetAddressCardProperties uses less memory than OpenAddressCard.

The Contacts database must have been opened by a previous call to the OpenAddressBook function.

See Also

AddressCard, FreeAddressCard, OpenAddressBook