FDO .NET API Reference Feature Data Objects

mgIProviderRegistry.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 BEGIN_NAMESPACE_OSGEO_FDO_CLIENTSERVICES
00022 public __gc class ProviderCollection;
00023 END_NAMESPACE_OSGEO_FDO_CLIENTSERVICES
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO
00026 
00027 /// \ingroup (OSGeoFDO)
00028 /// \interface OSGeo::FDO::IProviderRegistry
00029 /// \brief
00030 /// The IProviderRegistry interface supports registering, un-registering, and enumerating 
00031 /// registered feature providers. 
00032 ///
00033 /// \note
00034 /// This is not the Windows registry.
00035 public __gc __interface IProviderRegistry : public System::IDisposable
00036 {
00037 public:
00038     /// \brief
00039     /// Gets a read only collection of information describing each of the registered feature providers. 
00040     /// 
00041     /// \return
00042     /// Returns an an instance of ProviderCollection. Throws an instance of Exception if an error occurs.
00043     /// 
00044     NAMESPACE_OSGEO_FDO_CLIENTSERVICES::ProviderCollection* GetProviders();
00045 
00046     /// \brief
00047     /// Registers a provider given the necessary information to register the provider. 
00048     /// If any of the parameters are missing or invalid, an exception is thrown. 
00049     /// 
00050     /// \param name 
00051     /// The unique name of the feature provider. This name should be of the form 
00052     /// [Company].[Provider].[Version].
00053     /// \param displayName 
00054     /// A user friendly display name of the feature provider.
00055     /// \param description 
00056     /// A brief description of the feature provider.
00057     /// \param version 
00058     /// The version of the feature provider. The version number string has the form 
00059     /// [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
00060     /// \param fdoVersion 
00061     /// The version of the feature data objects specification the feature provider conforms to. 
00062     /// The version number string has the form [VersionMajor].[VersionMinor].[BuildMajor].[BuildMinor].
00063     /// \param libraryPath 
00064     /// The FULL library path + library name of the provider.
00065     /// \param isManaged 
00066     /// A flag indicating if the provider is a managed or unmanaged .Net provider.
00067     /// 
00068     /// \return
00069     /// Returns nothing. Throws an instance of Exception if an error occurs.
00070     /// 
00071     System::Void RegisterProvider(String * name, 
00072         String * displayName, 
00073         String * description, 
00074         String * version, 
00075         String * fdoVersion, 
00076         String * libraryPath,
00077         System::Boolean isManaged);
00078 
00079     /// \brief
00080     /// Unregisters the provider with the specified name. 
00081     /// 
00082     /// \param name 
00083     /// The unique name of the feature provider. This name should be of the form 
00084     /// [Company].[Provider].[Version].
00085     /// 
00086     /// \return
00087     /// Returns nothing. Throws an instance of Exception if an error occurs.
00088     /// 
00089     System::Void UnregisterProvider(String * name);
00090 
00091 };
00092 
00093 END_NAMESPACE_OSGEO_FDO
00094 
00095 

Comments or suggestions? Send us feedback.