- Main Page
- Related Pages
- Modules
- Classes
- Files

# IDestroyDataStore.h

Go to the documentation of this file.

    00001 #ifndef _IDESTROYDATASTORE_H_
    00002 #define _IDESTROYDATASTORE_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/IConnection.h>
    00028 #include <Fdo/Commands/ICommand.h>
    00029 #include <Fdo/Commands/DataStore/IDataStorePropertyDictionary.h>
    00030
    00031 /// \brief
    00032 /// The FdoIDestroyDataStore interface defines the destroy datastore command
    00033 /// that can be used to remove and existing datastore. The input is provided
    00034 /// through a dictionary of name value pairs that is provider dependant.
    00035 class FdoIDestroyDataStore : public FdoICommand
    00036 {
    00037     friend class FdoIConnection;
    00038
    00039 public:
    00040
    00041     /// \brief
    00042     /// Gets the FdoIDataStorePropertyDictionary interface that
    00043     /// can be used to dynamically query and set the properties required
    00044     /// to delete an existing datastore.
    00045     ///
    00046     /// \return
    00047     /// Returns the property dictionary
    00048     ///
    00049     FDO_API virtual FdoIDataStorePropertyDictionary* GetDataStoreProperties() = 0;
    00050
    00051     /// \brief
    00052     /// Executes the FdoIDeleteDataStore command.
    00053     ///
    00054     /// \return
    00055     /// Returns nothing
    00056     ///
    00057     FDO_API virtual void Execute() = 0;
    00058 };
    00059
    00060 #endif
    00061
    00062

Please send us your comment about this page