ConnectionParameter Class
Contents
[
Hide
]ConnectionParameter class
Specifies properties about any parameters used with external data connectionsParameters are valid for ODBC and web queries.
type ConnectionParameter struct {
ptr unsafe.Pointer
}
Constructors
| Method | Description |
|---|
Methods
| Method | Description |
|---|---|
| IsNull | Checks whether the implementation object is nullptr. |
| GetSqlType | SQL data type of the parameter. Only valid for ODBC sources. |
| SetSqlType | SQL data type of the parameter. Only valid for ODBC sources. |
| GetRefreshOnChange | Flag indicating whether the query should automatically refresh when the contents of acell that provides the parameter value changes. If true, then external data is refreshedusing the new parameter value every time there’s a change. If false, then external datais only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened). |
| SetRefreshOnChange | Flag indicating whether the query should automatically refresh when the contents of acell that provides the parameter value changes. If true, then external data is refreshedusing the new parameter value every time there’s a change. If false, then external datais only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened). |
| GetPrompt | Prompt string for the parameter. Presented to the spreadsheet user along with input UIto collect the parameter value before refreshing the external data. Used only whenparameterType = prompt. |
| SetPrompt | Prompt string for the parameter. Presented to the spreadsheet user along with input UIto collect the parameter value before refreshing the external data. Used only whenparameterType = prompt. |
| GetType | Type of parameter used.If the parameterType=value, then the value from boolean, double, integer,or string will be used. In this case, it is expected that only one of{boolean, double, integer, or string} will be specified. |
| SetType | Type of parameter used.If the parameterType=value, then the value from boolean, double, integer,or string will be used. In this case, it is expected that only one of{boolean, double, integer, or string} will be specified. |
| GetName | The name of the parameter. |
| SetName | The name of the parameter. |
| GetCellReference | Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell. |
| SetCellReference | Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell. |
| GetValue | Non-integer numeric value,Integer value,String value or Boolean valueto use as the query parameter. Used only when parameterType is value. |
| SetValue | Non-integer numeric value,Integer value,String value or Boolean valueto use as the query parameter. Used only when parameterType is value. |