Previous Topic: CcnfGetParameterInt - Read Common Configuration Parameter Integer ValueNext Topic: CcnfSetParameterInt - Modify the Value of an Existing Common Configuration Parameter (type string)


CcnfGetParameterStr - Read Common Configuration Parameter String Value

Valid on Windows and Unix

The CcnfGetParameterStr function reads the common configuration parameter string value.

Function format:

CcnfGetParameterStr(Parametername as string, Value as string) as boolean

Parametername

Name of a Common Configuration Parameter including its absolute path (for example, "itrm/rc/protocols/encrypt/dll")

Value

String value of Parametername.

The return value of the function is boolean. If the function is successful, it returns TRUE and Value contains the value of Parametername. If the function is not successful, an error is reported in the log file.

Example:

This example uses a comstore parameter:

Dim pText as string
if CcnfGetParameterStr("itrm/usd/shared/nos", pText) then
Print("itrm/usd/shared/nos = """ + pText + """" )
else
Print("CcnfGetParameterStr failed")
endif