C++ Syntax

bool

MKI_LibraryGetInfoByIndex(

__int32 f_nLibraryNum,

MKI_FILENAMEW& f_rFileName,

MKI_FILE_HEADER_PTR f_pFileHeader,

bool* f_pfIsReadOnly );

Retrieves information about a library by means of its index. Especially the library's title (located in its header) is used to identify that library inside instances.

Parameters

LibraryNum

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

FileName

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

FileHeader

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

IsReadOnly

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

Return Value

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