Struct DriverPropertyInfo

Devguide

struct DriverPropertyInfo

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.

Elements' Summary
Name	is the name of the property.
Description	is a brief description of the property, which may be null.
IsRequired	is true if a value must be supplied for this property during `Driver.connect` and false otherwise.
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.
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.

Elements' Details

Name

string Name; Description is the name of the property.

Description

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

IsRequired

boolean IsRequired; Description is true if a value must be supplied for this property during `Driver.connect` and false otherwise.

Value

string Value; Description specifies the current value of the property, based on the driver-supplied default values. This field may be empty if no value is known.

Choices

sequence< string > Choices; Description 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.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous