Share via

IContactPropertyCollection::GetPropertyArrayElementID Method

  • Article

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

Syntax

HRESULT GetPropertyArrayElementID(      
    LPWSTR pszArrayElementID,
    DWORD cchArrayElementID,
    DWORD *pdwcchArrayElementIDRequired
);

Parameters

  • pszArrayElementID
    [in, out] On success, contains the unique ID for the element.
  • cchArrayElementID
    [in] Specifies caller-allocated buffer size in characters.
  • pdwcchArrayElementIDRequired
    [in, out] On failure, contains the required size for pszArrayElementID.

Return Value

Returns one of the following values.

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.