GPMID_GetLyricsLine function

Print

Retrieves a lyrics line in the tablature which is currently loaded.

Syntax

Print 

  1. GPMID_ENTRY const char* GPMID_GetLyricsLine(
  2. 	unsigned int aLineIdx
  3. );

Parameters

  1. aLineIdx

    The zero-based index of the lyrics line to retrieve.

Return value

The corresponding lyrics line embedded in the tablature.

Remarks

Before using this function, GPMID must have been initialized with GPMID_Init and a tablature must have been successfully loaded with GPMID_Load.

Up to 5 lyrics lines may be embedded in tablatures so this function can be called with an index ranging from 0 to 4. If the corresponding lyrics line is not set, the function returns an empty string.