Edit

Share via

IContactProperties::SetLabels method (icontact.h)

  • Article

Appends the set of labels passed in to the specified property's label set. Note: This method does not check for duplicate labels.

Syntax

HRESULT SetLabels(
  [in] LPCWSTR    pszArrayElementName,
  [in] DWORD      dwFlags,
  [in] DWORD      dwLabelCount,
  [in] LPCWSTR [] ppszLabels
);

Parameters

[in] pszArrayElementName

Type: LPCWSTR

Specifies the property to label.

[in] dwFlags

Type: DWORD

Must be CGD_DEFAULT.

[in] dwLabelCount

Type: DWORD

Specifies the count of labels in array.

[in] ppszLabels

Type: LPCWSTR

Specifies an array of LPCWSTR labels.

Return value

Type: HRESULT

Returns one of the following values:

Return code Description
S_OK
 Labels set successfully.
ERROR_PATH_NOT_FOUND
 No data found for this property name.
ERROR_INVALID_DATATYPE
 Unable to set value for this property due to schema.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header icontact.h (include Contact.h)
DLL Wab32.dll (Version 6.0 or later)