C++ Syntax

bool

MKI_DialogCollectionHandleName(

HWND f_hWindow,

__int32 f_nCtlID,

__int32 f_nType,

const LPCWSTR f_pszNameIn,

LPWSTR f_pszNameOut,

const size_t f_unMaxSize );

template <size_t f_unSize> __forceinline bool

MKI_DialogCollectionHandleName(

HWND f_hWindow,

__int32 f_nCtlID,

__int32 f_nType,

const LPCWSTR f_pszNameIn,

wchar_t (&f_rNameOut)[f_unSize] );

Displays a context menu for handling element names in the pinboard and the collections. It enables the user to add a given element name (such as layer, pen, etc.) to the pinboard or a collection, or to get an element name from the pinboard or a collection.

Parameters

Window

[HWND] Handle of the dialog window whose control was clicked.

CtlID

[__int32] ID of the control that was clicked (only used to position the context menu).

Type

[__int32] Type of the items to handle, must be one of the element name type (see MKI_COLLECTION_TYPE*).

NameIn

[const LPCWSTR] Current element name that can be stored. May be nullptr if nothing can be stored, the corresponding menu items will be disabled.

NameOut

[LPWSTR] Element name chosen by the user. May be nullptr if nothing can be chosen, the corresponding menu items will be disabled.

MaxSize

[const size_t] Maximum allowed size of the name in characters including the terminating zero. Maximum allowed value is MKI_LENGTH_TEXT_LONG.

Return Value

Returns true if the user chose an item from the pinboard or a collection, the resulting data was stored in NameOut.