C++ Syntax

__int32

MKI_DatabaseCleanUp(

__int32 f_nDatabaseIndex );

Cleans up the given database. Each record that is not assigned (refer to MKI_COLUMNASSIGN_OBJECT_ID) to an existing object in the current drawing is removed.

Parameters

DatabaseIndex

[__int32] Index of the database that shall be cleaned up. A value between MKI_BLOCK_INDEX and MKI_BLOCK_INDEX + MKI_DATABASE_INTERNAL_MAX - 1 indicates an internal database: MKI_BLOCK_INDEX refers to the drawing's default internal database (with empty name), MKI_BLOCK_INDEX + 1 through MKI_BLOCK_INDEX + MKI_DATABASE_INTERNAL_MAX - 1 refer to the other named internal database (with non-empty names). To access an external database, use value between 0 and MKI_DATABASE_MAX - 1.

Return Value

Returns the number of records that were removed, otherwise zero is returned.

Comment

To access an internal database, DatabaseIndex must be a value between MKI_BLOCK_INDEX and MKI_BLOCK_INDEX + MKI_DATABASE_INTERNAL_MAX - 1. MKI_BLOCK_INDEX refers to the drawing's default internal database (with empty name), MKI_BLOCK_INDEX + 1 through MKI_BLOCK_INDEX + MKI_DATABASE_INTERNAL_MAX - 1 refer to the other named internal database (with non-empty names).

To access an external database, DatabaseIndex must be a value between 0 and MKI_DATABASE_MAX - 1.