FDO API Reference Feature Data Objects

IConnectionInfo.h

Go to the documentation of this file.
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 
00029 /// \brief
00030 /// The FdoIConnectionInfo interface exposes information about the feature provider
00031 /// and provides access to the FdoIConnectionPropertyDictionary interface.
00032 class FdoIConnectionInfo : public FdoIDisposable
00033 {
00034 public:
00035     /// \brief
00036     /// Gets the name of the feature provider.
00037     /// 
00038     /// \return
00039     /// Returns the provider name
00040     /// 
00041     FDO_API virtual FdoString* GetProviderName() = 0;
00042 
00043     /// \brief
00044     /// Gets the display name of the feature provider.
00045     /// 
00046     /// \return
00047     /// Returns the provider's display name
00048     /// 
00049     FDO_API virtual FdoString* GetProviderDisplayName() = 0;
00050 
00051     /// \brief
00052     /// Gets the description of the feature provider.
00053     /// 
00054     /// \return
00055     /// Returns the provider description
00056     /// 
00057     FDO_API virtual FdoString* GetProviderDescription() = 0;
00058 
00059     /// \brief
00060     /// Gets the version of the feature provider.
00061     /// 
00062     /// \return
00063     /// Returns provider version
00064     /// 
00065     FDO_API virtual FdoString* GetProviderVersion() = 0;
00066 
00067     /// \brief
00068     /// Gets the version of the Feature Data Objects specification to which this provider conforms.
00069     /// 
00070     /// \return
00071     /// Returns FDO version supported.
00072     /// 
00073     FDO_API virtual FdoString* GetFeatureDataObjectsVersion() = 0;
00074 
00075     /// \brief
00076     /// Gets the FdoIConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
00077     /// 
00078     /// \return
00079     /// Returns the property dictionary
00080     /// 
00081     FDO_API virtual FdoIConnectionPropertyDictionary* GetConnectionProperties() = 0;
00082 };
00083 #endif
00084 
00085 

Comments or suggestions? Send us feedback.