3P API Functions

Lib3PInit

bool Lib3PInit(char* InFile)

Initialize the 3P API library with the given 3P file. For InFile specify the full path and file name of the 3P file.

This function returns TRUE if the library initialization is successful. This function returns FALSE due to error in file name, file type and/or path.

Lib3PClose

void Lib3PClose()

Call this function to close the 3P API library and to clear the allocated memory.

Lib3PGetGeneralInfo

char* Lib3PGetGeneralInfo(char* Key)

Return the "general information" (enclosed by general tags) value in the specified Key. Some of the valid keys for this function are name, desc, version, release, etc.

Lib3PGetDeveloperInfo

char* Lib3PGetDeveloperInfo(char* Key)

Return the developers information in specified Key (which are enclosed by developer tags). Some of the valid keys for this function are name, url, etc.

Lib3PSecondarySectionExists

bool Lib3PSecondarySectionExists(char* Section : PChar)

Check specified main section is exist in target 3P file.

Lib3PGetSecondaryStringValue

char* Lib3PGetSecondaryStringValue(char* Section, char* Key)

Load value from the specified Key and Section. Before load the value it is recommended to check the existence of target Section by Lib3PSecondarySectionExists function.

This function returns an empty string if specified Key or Section is not exists/invalid.

Lib3PGetSecondaryListCount

int Lib3PGetSecondaryListCount(char* Section, char* Key)

Return the number of array elements in specified Key and Section. This function is recommended to use only for array related Keys.

Lib3PGetSecondaryListCount returns -1 if the specified Key or Section is not exists/invalid.

Lib3PGetSecondaryListValue

char* Lib3PGetSecondaryListValue(char* Section, char* Key, int Index)

Return the value of the array element specified by Key, Section and Index. Valid range for Index is from 0 to "length of array - 1". The length of the array can be obtain through Lib3PGetSecondaryListCount function.

Lib3PExecMD5

bool Lib3PExecMD5(char* FileName)

This function check the 3P md5 hash code with supplied FileName. This function returns FALSE if the specified file is not exists or not matched with the target 3P md5 hash code.

Lib3PGetCoreFile

char* Lib3PGetCoreFile() 

Return the "core file name" of the target 3P session.

Lib3PGetLicenseName

char* Lib3PGetLicenseName() 

Return the short-name (e.g: LGPL-3.0, MIT, CC-BY-3.0, etc.) of the license used by target 3P session.

Lib3PGetContributeURL

char* Lib3PGetContributeURL() 

Return the project contribution URL of the target 3P session.