| FDO API Reference | Feature Data Objects |
00001 #ifndef _ICONNECTIONINFO_H_ 00002 #define _ICONNECTIONINFO_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 #include <Fdo/Connections/IConnectionPropertyDictionary.h> 00028 #include <Fdo/Connections/ProviderDatastoreType.h> 00029 00030 /// \brief 00031 /// The FdoIConnectionInfo interface exposes information about the feature provider 00032 /// and provides access to the FdoIConnectionPropertyDictionary interface. 00033 class FdoIConnectionInfo : public FdoIDisposable 00034 { 00035 public: 00036 /// \brief 00037 /// Gets the name of the feature provider. 00038 /// 00039 /// \return 00040 /// Returns the provider name 00041 /// 00042 FDO_API virtual FdoString* GetProviderName() = 0; 00043 00044 /// \brief 00045 /// Gets the display name of the feature provider. 00046 /// 00047 /// \return 00048 /// Returns the provider's display name 00049 /// 00050 FDO_API virtual FdoString* GetProviderDisplayName() = 0; 00051 00052 /// \brief 00053 /// Gets the description of the feature provider. 00054 /// 00055 /// \return 00056 /// Returns the provider description 00057 /// 00058 FDO_API virtual FdoString* GetProviderDescription() = 0; 00059 00060 /// \brief 00061 /// Gets the version of the feature provider. 00062 /// 00063 /// \return 00064 /// Returns provider version 00065 /// 00066 FDO_API virtual FdoString* GetProviderVersion() = 0; 00067 00068 /// \brief 00069 /// Gets the version of the Feature Data Objects specification to which this provider conforms. 00070 /// 00071 /// \return 00072 /// Returns FDO version supported. 00073 /// 00074 FDO_API virtual FdoString* GetFeatureDataObjectsVersion() = 0; 00075 00076 /// \brief 00077 /// Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection. 00078 /// 00079 /// \return 00080 /// Returns the property dictionary 00081 /// 00082 FDO_API virtual FdoIConnectionPropertyDictionary* GetConnectionProperties() = 0; 00083 00084 /// \brief 00085 /// Returns the provider type. A provider can be a file-based, database-based or 00086 /// web-based provider. The valid values the function may return are defined in 00087 /// the enumeration FdoProviderDatastoreType. The enumeration includes the following 00088 /// values: FdoProviderDatastoreType_Unknown, FdoProviderDatastoreType_File, 00089 /// FdoProviderDatastoreType_DatabaseServer, FdoProviderDatastoreType_WebServer. 00090 /// 00091 /// \return 00092 /// Returns the provider data store type. 00093 /// 00094 FDO_API virtual FdoProviderDatastoreType GetProviderDatastoreType() = 0; 00095 00096 /// \brief 00097 /// File-based providers depend on a various files. This function returns a list 00098 /// of fully qualified dependend file names. The return parameter will be NULL if 00099 /// the provider is not a file-based provider. 00100 /// 00101 /// \return 00102 /// Returns the list of fully-qualified dependend file names if the provider is a 00103 /// file-based provider, NULL otherwise. 00104 /// 00105 FDO_API virtual FdoStringCollection* GetDependentFileNames() = 0; 00106 }; 00107 #endif 00108 00109
| Comments or suggestions? Send us feedback. |