IContactPropertyCollection::GetPropertyArrayElementID Method

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

pszArrayElementID [in, out]
LPWSTR

On success, contains the unique ID for the element.

cchArrayElementID [in]
DWORD

Specifies caller-allocated buffer size in characters.

pdwcchArrayElementIDRequired [in, out]
DWORD

On failure, contains the required size for pszArrayElementID.

Return Value

HRESULT

Returns one of the following values.

Return codeDescription
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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Contact.h

IDL

Icontact.idl

DLL

Wab32.dll version 6.0 or later

See Also

IContactPropertyCollection

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2010

Show: