MKI_CollectionGetInfo (Collections) New in Version 2020.0

C++ Syntax

bool

MKI_CollectionGetInfo(

 __int32 f_nCollectionNum,

 MKI_FILENAMEW& f_rFileName,

 MKI_FILE_HEADER_PTR f_pFileHeader,

 bool* f_pfIsReadOnly );

Retrieves information about a collection. Especially the collection's title (located in its header) is used to identify that collection.

Not supported in CAD6starter!

Parameters

f_nCollectionNum

[__int32] Zero-based index of the collection whose title shall be retrieved.

f_rFileName

[MKI_FILENAMEW&] Address of buffer to receive the collection's file name.

f_pFileHeader

[MKI_FILE_HEADER_PTR] Address of buffer to receive the collection's header. If f_pFileHeader is nullptr, no header will be returned.

f_pfIsReadOnly

[bool*] Address of a bool to receive the collection's current status. If the collection is read-only true will be returned, otherwise false.

Return Value

Returns true if successful. If false is returned, the given f_nCollectionNum was invalid.