getConfigProp()

Retrieves a connector configuration property from the repository.

Syntax

int getConfigProp(char * prop, char * val, int nMaxCount);
 

Parameters

prop [in]
is the name of the property to retrieve.

val [out]
is a pointer to a buffer to which the method can write the property value.

nMaxCount [in]
is the number of bytes in the value buffer.

Return values

An integer that specifies the number of bytes that the method copied to the value buffer.

Notes

This is a utility method for connector developers to use.

When you call getConfigProp("ConnectorName") in a parallel-process connector (one that has the ParallelProcessDegree connector property set to a value greater than 1), the method always returns the name of the connector-agent master process, regardless of whether it is called in the master process or a slave process.

Examples

if (getConfigProp("LoginId", val, 255) == 0);
    {
    logMsg("Invalid LoginId");
    traceWrite(Tracing::LEVEL3, "Invalid LoginId", NULL);
    }
 

Copyright IBM Corp. 1997, 2003