LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
DriverPropertyInfo Struct Referencepublished

describes the driver properties for making a connection. More...

import"DriverPropertyInfo.idl";

Public Attributes

string Name
 is the name of the property. More...
 
string Description
 is a brief description of the property, which may be null. More...
 
boolean IsRequired
 is TRUE if a value must be supplied for this property during Driver.connect and FALSE otherwise. More...
 
string Value
 specifies the current value of the property, based on the driver-supplied default values. More...
 
sequence< string > Choices
 contains a sequence of possible values if the value for the field DriverPropertyInfo.value may be selected from a particular set of values; otherwise empty. More...
 

Detailed Description

describes the driver properties for making a connection.

The DriverPropertyInfo is of interest only to advanced programmers who need to interact with a driver to discover and supply properties for connections.

Member Data Documentation

sequence<string> Choices

contains a sequence of possible values if the value for the field DriverPropertyInfo.value may be selected from a particular set of values; otherwise empty.

string Description

is a brief description of the property, which may be null.

boolean IsRequired

is TRUE if a value must be supplied for this property during Driver.connect and FALSE otherwise.

string Name

is the name of the property.

string Value

specifies the current value of the property, based on the driver-supplied default values.

This field may be empty if no value is known.


The documentation for this struct was generated from the following file: