MKI_DatabaseGetDisplayName (Databases) Changed in Version 2019.0

C++ Syntax

bool

MKI_DatabaseGetDisplayName(

 __int32 f_nDatabaseIndex,

 MKI_DATABASENAME& f_rDisplayName );

Retrieves the display name of the given database to be displayed in the user interface. This is not the name by which a database can be referenced internally!

Parameters

DatabaseIndex

[__int32] Index of the database whose data shall be retrieved. 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.

DisplayName

[MKI_DATABASENAME&] Address of a text to receive the database's display name.

Return Value

Returns true if successful, false if not.