Edit

Share via

IContactPropertyCollection::GetPropertyName method (icontact.h)

  • Article

Retrieves the name for the current property in the enumeration.

Syntax

HRESULT GetPropertyName(
  [in, out] LPWSTR pszPropertyName,
  [in]      DWORD  cchPropertyName,
  [in, out] DWORD  *pdwcchPropertyNameRequired
);

Parameters

[in, out] pszPropertyName

Type: LPWSTR

On success, contains the name to use for querying on IContactProperties. EX: toplevel -or- toplevel/secondlevel[4]/thirdlevel.

[in] cchPropertyName

Type: DWORD

Specifies caller-allocated buffer size in characters.

[in, out] pdwcchPropertyNameRequired

Type: DWORD*

On failure, contains the required size for pszPropertyName.

Return value

Type: HRESULT

Returns one of the following values:

Return code Description
S_OK
 Query is successful.
ERROR_INSUFFICIENT_BUFFER
 pszPropertyName was not large enough to store the value. The required buffer size is stored in *pdwcchPropertyNameRequired.

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)