SetColumnProperties

The SetColumnProperties function specifies the columns on which the Contacts database can be sorted.

Syntax

BOOL SetColumnProperties(HHPRTAG *propList, int nColumns);

At a Glance

Parameters

propList

Pointer to an array of up to four property tags that identify column properties on which the address cards can be sorted. For a list of these tags, see Contacts Database. Property tags begin with the HHPR_ prefix. If this parameter is NULL, SetColumnProperties uses the following property tags by default:

HHPR_SURNAME

Sort based on surnames.

HHPR_COMPANY_NAME

Sort based on company names.

HHPR_OFFICE_TELEPHONE_NUMBER

Sort based on the office telephone numbers.

HHPR_HOME_TELEPHONE_NUMBER

Sort based on home telephone numbers.

nColumns

Number of property tags in the propList array. If propList is NULL, this parameter is ignored.

Return Values

Returns TRUE if successful, or FALSE otherwise.

Remarks

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

For more information, see Contacts Database.

See Also

GetColumnProperties