SetParameter method

The SetParameter method provides a way for your application to write (set) the value of a CT Access parameter. These parameters are maintained for each application that uses CT Access (or ActiveAG) – or they can be global parameters for an entire system under certain conditions (see the CT Access Developer’s Manual).

Since there are a very large number of parameters for CT Access, ActiveAG does not provide properties for all of them. ActiveAG only provides property interfaces for the most commonly used CT Access parameters. This method allows your application to write the value of CT Access parameters that aren’t exposed as ActiveAG properties. (Of course, it can also be used to write the values of parameters that are exposed as properties but that isn’t necessary.)

Type

Arguments: ParameterName BSTR

Returns: A BSTR containing the parameter value, if found; otherwise an empty string.

Property interactions: If this method is used to write the value of a CT Access parameter that is exposed as an ActiveAG property, then the value written with this method will be ignored. That is, ActiveAG property settings have priority over CT Access parameter values when a property setting is available for a CTA parameter.