C++ Syntax

bool

MKI_CollectionDeleteItem(

const LPCWSTR f_pszCollectionName,

__int32 f_nOwnerID,

__int32 f_nType,

const LPCWSTR f_pszItemName );

Removes a collection item.

Not supported in CAD6starter!

Parameters

f_pszCollectionName

[const LPCWSTR] Title of the collection from which the item shall be removed. If the collection name is MKI_BLOCK_ID, the drawing's internal collection will be accessed.

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_pszItemName

[const LPCWSTR] Name of the collection item.

Return Value

Returns true if successful, false if not.

Comment

Make sure not to remove the item that is currently open by means of MKI_CollectionReadItemOpen.