C++ Syntax

bool

MKI_CollectionWriteItemOpen(

HWND f_hWindow,

const LPCWSTR f_pszCaption,

__int32 f_nOwnerID,

__int32 f_nType,

__int32 f_nVersion );

Opens a temporary collection item for adding item data. The user will be prompted for a collection and an item name.

Not supported in CAD6starter!

Parameters

f_hWindow

[HWND] Handle of the dialog window's parent window.

f_pszCaption

[const LPCWSTR] Title of the dialog window to be displayed. Be careful that the given title fits into the dialog window's caption. If nullptr, the dialog's default title will be used.

f_nOwnerID

[__int32] This value is a unique identification of the creator of the plug-in that created the data block. The value MKI_DB_OWNER_MK is reserved for use by Malz++Kassner, especially for collection items that are created and handled directly by the application. Valid range: 0 <= Value < 10000.

Third-party vendors that plan to implement a plug-in should contact Malz++Kassner to receive their unique identification (see Getting Your Private Owner ID).

f_nType

[__int32] This value is an internal identification of the item. This value is known only the creator of that item. For information about this value see the documentation of the plug-in which should include a description of all collection items it uses. In combination with the owner's identification, this unambiguously identifies a certain type of collection item. Must not be negative. For a list of types used by Malz++Kassner, see MKI_COLLECTION_TYPE_*.

f_nVersion

[__int32] A mandatory version information on the collection item. Use this to ensure backward compatibility for future versions. Since collections are not automatically updated when used by a newer version, this version information is required to be able to interpret the item's contents correctly at all times. Must not be negative.

Return Value

Returns true if successful, false if not.

Comment

Once opened, use the standard profile writing commands to write the data, see MKI_ProfileWriteString and others.

Only one item can be open for writing at a time. Before being able to open another item for writing, the plug-in has to call MKI_CollectionWriteClose. Neither the item itself nor any data added to it will be written to the collection unless MKI_CollectionWriteClose is called with f_fApply = true.