nf-icontact-icontactproperties-createarraynode.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:icontact.IContactProperties.CreateArrayNode	IContactProperties::CreateArrayNode (icontact.h)	Creates a new array node in a multi-value property.	CreateArrayNode CreateArrayNode method [Windows Contacts] CreateArrayNode method [Windows Contacts] IContactProperties interface IContactProperties interface [Windows Contacts] CreateArrayNode method IContactProperties.CreateArrayNode IContactProperties::CreateArrayNode _wincontacts_IContactProperties_CreateArrayNode icontact/IContactProperties::CreateArrayNode wincontacts._wincontacts_IContactProperties_CreateArrayNode	wincontacts\_wincontacts_IContactProperties_CreateArrayNode.htm	wincontacts	422b9991-c8ac-4e8b-9432-1ccba02f7cfd	12/05/2018	CreateArrayNode, CreateArrayNode method [Windows Contacts], CreateArrayNode method [Windows Contacts],IContactProperties interface, IContactProperties interface [Windows Contacts],CreateArrayNode method, IContactProperties.CreateArrayNode, IContactProperties::CreateArrayNode, _wincontacts_IContactProperties_CreateArrayNode, icontact/IContactProperties::CreateArrayNode, wincontacts._wincontacts_IContactProperties_CreateArrayNode	icontact.h	Contact.h	Windows	Windows Vista [desktop apps only]	Windows Server 2003 [desktop apps only]					Icontact.idl						Wab32.dll (Version 6.0 or later)		Windows			19H1	IContactProperties::CreateArrayNode icontact/IContactProperties::CreateArrayNode	c++	APIRef kbSyntax	COM	Wab32.dll	IContactProperties.CreateArrayNode

IContactProperties::CreateArrayNode

-description

Creates a new array node in a multi-value property.

-parameters

-param pszArrayName [in]

Type: LPCWSTR

Specifies the top-level property for which to create a new node.

-param dwFlags [in]

Type: DWORD

Must be CGD_DEFAULT.

-param fAppend [in]

Type: BOOL

TRUE for insert after, FALSE for insert before.

-param pszNewArrayElementName [in, out]

Type: LPWSTR

Specifies a user-allocated buffer to store the new array element name.

-param cchNewArrayElementName [in]

Type: DWORD

Specifies an allocated buffer size in characters.

-param pdwcchNewArrayElementNameRequired [in, out]

Type: DWORD*

On failure, contains the required size for pszNewArrayElementName.

-returns

Type: HRESULT

Returns one of the following values:

Return code	Description
S_OK	New node is created and name is in pszNewArrayElementName.
ERROR_PATH_NOT_FOUND	Macro HRESULT_FROM_WIN32(ERROR_PATH_NOT_FOUND) returned when array name is invalid.
ERROR_INSUFFICIENT_BUFFER	Macro HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) returned when pszNewArrayElementName is not large enough to store the value. The required buffer size is stored in pdwcchNewArrayElementNameRequired.

-remarks

Note  The first element of an existing set is at index 1.

 

To create a pszArrayName at toplevel/secondlevel[1], call this function with pszArrayName == toplevel, fAppend=FALSE.

To create an array node that is an extension at [namespace]toplevel/secondlevel[1], call this function with pszArrayName == [namespace:secondlevel]toplevel.

To append to the set, pass fAppend=TRUE instead; pszNewArrayElementName then contains the resulting array node name, including the index.