ReadLibraryConfigStringS [LJM User's Guide]

Read one string-based configuration value.

Syntax

LJM_ERROR_RETURN LJM_ReadLibraryConfigStringS(
const char * Parameter,
double * String)

Parameters

Parameter [in]

The name of the configuration setting, see configuration parameters page. Not case-sensitive. Must null-terminate. For the full list of possible parameters, see Configuration Parameters.

String [out]

The return value string representing the current value of Parameter. Must be allocated to size LJM_MAX_NAME_SIZE.

Returns

LJM errorcodes or 0 for no error.

Remarks

To write a string-based configuration parameter, see LJM_WriteLibraryConfigStringS.

To read a numerical configuration parameter, see LJM_ReadLibraryConfigS.

Example

Read LJM_DEBUG_LOG_FILE

char ErrorString[LJM_MAX_NAME_SIZE];
char String[LJM_MAX_NAME_SIZE];
int LJMError = LJM_ReadLibraryConfigStringS(LJM_DEBUG_LOG_FILE, String);
if (LJMError != 0) {
    LJM_ErrorToString(LJMError, ErrorString);
    printf("LJM_ReadLibraryConfigStringS error: %s\n", ErrorString);
}
printf("LJM_DEBUG_LOG_FILE is currently %s\n", String);