FDO .NET API Reference Feature Data Objects

mgIConnectionInfo.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "FDO\Connections\mgProviderDatastoreType.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_CONNECTIONS
00024 public __gc __interface IConnectionPropertyDictionary;
00025 
00026 /// \ingroup (OSGeoFDOConnections)
00027 /// \interface OSGeo::FDO::Connections::IConnectionInfo
00028 /// \brief
00029 /// The IConnectionInfo interface exposes information about the feature provider
00030 /// and provides access to the IConnectionPropertyDictionary interface.
00031 public __gc __interface IConnectionInfo : public System::IDisposable
00032 {
00033 public:
00034     /// \brief
00035     /// Gets the name of the feature provider.
00036     /// 
00037     /// \return
00038     /// Returns the provider name
00039     /// 
00040     __property System::String* get_ProviderName();
00041 
00042     /// \brief
00043     /// Gets the display name of the feature provider.
00044     /// 
00045     /// \return
00046     /// Returns the provider's display name
00047     /// 
00048     __property System::String* get_ProviderDisplayName();
00049 
00050     /// \brief
00051     /// Gets the description of the feature provider.
00052     /// 
00053     /// \return
00054     /// Returns the provider description
00055     /// 
00056     __property System::String* get_ProviderDescription();
00057 
00058     /// \brief
00059     /// Gets the version of the feature provider.
00060     /// 
00061     /// \return
00062     /// Returns provider version
00063     /// 
00064     __property System::String* get_ProviderVersion();
00065 
00066     /// \brief
00067     /// Gets the version of the Feature Data Objects specification to which this provider conforms.
00068     /// 
00069     /// \return
00070     /// Returns FDO version supported.
00071     /// 
00072     __property System::String* get_FeatureDataObjectsVersion();
00073 
00074     /// \brief
00075     /// Gets the IConnectionPropertyDictionary interface that can be used to dynamically query and set the properties required to establish a connection.
00076     /// 
00077     /// \return
00078     /// Returns the property dictionary
00079     /// 
00080     __property NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnectionPropertyDictionary* get_ConnectionProperties();
00081 
00082     /// \brief
00083     /// Returns the provider type. A provider can be a file-based, database-based or
00084     /// web-based provider. The valid values the function may return are defined in
00085     /// the enumeration ProviderDatastoreType. The enumeration includes the following
00086     /// values: ProviderDatastoreType_Unknown, ProviderDatastoreType_File,
00087     /// ProviderDatastoreType_DatabaseServer, ProviderDatastoreType_WebServer.
00088     /// 
00089     /// \return
00090     /// Returns the provider data store type.
00091     /// 
00092     __property NAMESPACE_OSGEO_FDO_CONNECTIONS::ProviderDatastoreType get_ProviderDatastoreType();
00093 
00094     /// \brief
00095     /// File-based providers depend on a various files. This function returns a list
00096     /// of fully qualified dependend file names. The return parameter will be NULL if
00097     /// the provider is not a file-based provider.
00098     /// 
00099     /// \return
00100     /// Returns the list of fully-qualified dependend file names if the provider is a
00101     /// file-based provider, NULL otherwise.
00102     /// 
00103     __property NAMESPACE_OSGEO_COMMON::StringCollection* get_DependentFileNames();
00104 };
00105 
00106 END_NAMESPACE_OSGEO_FDO_CONNECTIONS
00107 
00108 

Comments or suggestions? Send us feedback.