C++ Syntax

bool

MKI_DialogCollectionHandleFile(

HWND f_hWindow,

__int32 f_nCtlID,

const LPCWSTR f_pszFileNameIn,

MKI_FILENAMEW* f_pFileNameOut );

Displays a context menu for handling file names in the pinboard and the collections. It enables the user to add a given file name to the pinboard or a collection, or to get a file 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).

FileNameIn

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

FileNameOut

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

Return Value

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