Edit

IContactPropertyCollection::GetPropertyArrayElementID method (icontact.h)

  • Article

Retrieves the unique ID for a given element in a property array.

Syntax

HRESULT GetPropertyArrayElementID(
  [in, out] LPWSTR pszArrayElementID,
  [in]      DWORD  cchArrayElementID,
  [in, out] DWORD  *pdwcchArrayElementIDRequired
);

Parameters

[in, out] pszArrayElementID

Type: LPWSTR

On success, contains the unique ID for the element.

[in] cchArrayElementID

Type: DWORD

Specifies caller-allocated buffer size in characters.

[in, out] pdwcchArrayElementIDRequired

Type: DWORD*

On failure, contains the required size for pszArrayElementID.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
 Query is successful.
S_FALSE
 Array node does not have a unique array element ID.
ERROR_INSUFFICIENT_BUFFER
 pszArrayElementID was not large enough to store the value. The required buffer size is stored in *pdwcchArrayElementIDRequired.

Remarks

Note  Valid only when IContactPropertyCollection::GetPropertyType returns CGD_ARRAY_NODE for the current property.
 

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)