FDO API Reference Feature Data Objects

ArgumentDefinitionCollection.h

Go to the documentation of this file.
00001 #ifndef _ARGUMENTDEFINITIONCOLLECTION_H_
00002 #define _ARGUMENTDEFINITIONCOLLECTION_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/Capabilities/ArgumentDefinition.h>
00028 #include <Fdo/Connections/ConnectionException.h>
00029 
00030 /// \brief
00031 /// The FdoArgumentDefinitionCollection class represents a collection of FdoArgumentDefinition objects.
00032 class FdoArgumentDefinitionCollection : public FdoCollection<FdoArgumentDefinition, FdoConnectionException>
00033 {
00034 protected:
00035     virtual void Dispose();
00036 
00037 public:
00038     /// \brief
00039     /// Constructs a default empty instance of an FdoArgumentDefinitionCollection.
00040     /// 
00041     /// \return
00042     /// Returns FdoArgumentDefinitionCollection
00043     /// 
00044     FDO_API static FdoArgumentDefinitionCollection* Create();
00045 
00046     /// \brief
00047     /// Constructs an FdoArgumentDefinitionCollection from an array of FdoArgumentDefinition objects.
00048     /// 
00049     /// \param arguments 
00050     /// Input an array of FdoArgumentDefinition objects
00051     /// \param length 
00052     /// Input the number of arguments
00053     /// 
00054     /// \return
00055     /// Returns FdoArgumentDefinitionCollection
00056     /// 
00057     FDO_API static FdoArgumentDefinitionCollection* Create(FdoArgumentDefinition** arguments, FdoInt32 length);
00058 };
00059 #endif
00060 
00061 

Comments or suggestions? Send us feedback.