ConnectionSettingInfo Struct Reference

Structure describing the connection settings accepted by UpdateConnectionSettings and Connect functions. More...

List of all members.

Public Types

enum  { CustomRangeStart = 0x70000000UL, CustomRangeEnd = 0x7FFFFFFFUL }
 

Range of acceptable values for custom property IDs.

More...

Public Member Functions

 ConnectionSettingInfo ()

Public Attributes

bool isRequired
 Indicates if this key is ALWAYS required to be present. Keys that are only required when certain other keys are present should not be described as required here. Keys that are only conditionally required such as those, should be handled as appropriate during UpdateConnectionSettings.
bool isSensitive
 Is this property considered sensitive by DBPROP_AUTH_PERSIST_SENSITIVE_AUTHINFO. This is only checked for custom properties. Sensitivity of built-in properties is fixed.
simba_wstring key
 Key for this property when added to a DSIConnSettingRequestMap. For connections in ODBC drivers, this must be a valid key for an ODBC connection string. For connections in OLEDB providers, the following limitations apply to the key: All keys must be unique. All keys are NOT to be localized. Keys must not contain the equal sign or single or double quotation marks. However, they may contain semicolons. Keys entered into the ConnectionSettingInfoMap for custom property IDs (range CustomRangeStart-CustomRangeEnd) must not use the same string as any description for any defined OLEDB property. See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms723066(v=vs.85).aspx Example: A custom entry for 0x70000001 may not use the key "Data Source Name" because it conflicts with the description for DBPROP_DATASOURCENAME.
std::vector< Variantvalues
 An optional list of values that are valid for this property. Typical uses for this are enumerated values for integer settings or string settings with a limited set of valid values.
Variant::VariantValueType valueType
 The data type of values for this key. This may not be strictly enforced and the DSII should still be prepared for values that aren't convertible to the described type. May not be TYPE_NULL.

Detailed Description

Structure describing the connection settings accepted by UpdateConnectionSettings and Connect functions.


Member Enumeration Documentation

anonymous enum

Range of acceptable values for custom property IDs.

Enumerator:
CustomRangeStart 
CustomRangeEnd 

Constructor & Destructor Documentation

ConnectionSettingInfo (  )  [inline]

Member Data Documentation

bool isRequired

Indicates if this key is ALWAYS required to be present. Keys that are only required when certain other keys are present should not be described as required here. Keys that are only conditionally required such as those, should be handled as appropriate during UpdateConnectionSettings.

Is this property considered sensitive by DBPROP_AUTH_PERSIST_SENSITIVE_AUTHINFO. This is only checked for custom properties. Sensitivity of built-in properties is fixed.

Key for this property when added to a DSIConnSettingRequestMap. For connections in ODBC drivers, this must be a valid key for an ODBC connection string. For connections in OLEDB providers, the following limitations apply to the key: All keys must be unique. All keys are NOT to be localized. Keys must not contain the equal sign or single or double quotation marks. However, they may contain semicolons. Keys entered into the ConnectionSettingInfoMap for custom property IDs (range CustomRangeStart-CustomRangeEnd) must not use the same string as any description for any defined OLEDB property. See: http://msdn.microsoft.com/en-us/library/windows/desktop/ms723066(v=vs.85).aspx Example: A custom entry for 0x70000001 may not use the key "Data Source Name" because it conflicts with the description for DBPROP_DATASOURCENAME.

std::vector<Variant> values

An optional list of values that are valid for this property. Typical uses for this are enumerated values for integer settings or string settings with a limited set of valid values.

All values in this vector MUST have been constructed with the same Variant constructor that corresponds to creating a Variant of the valueType set above.

The data type of values for this key. This may not be strictly enforced and the DSII should still be prepared for values that aren't convertible to the described type. May not be TYPE_NULL.


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

Generated on Wed May 17 14:21:15 2017 for SimbaEngine 10.1.3.1011 by simba