FDO API Reference Feature Data Objects

ConnectionState.h

Go to the documentation of this file.
00001 #ifndef _CONNECTIONSTATE_H_
00002 #define _CONNECTIONSTATE_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 /// \brief
00027 /// The FdoConnectionState enumeration indicates the current state of the connection
00028 /// <param name="FdoConnectionState_Busy">
00029 /// The connection is busy executing one or more commands. Executing another
00030 /// command while the connection is busy will result in an exception.
00031 /// </param>
00032 /// <param name="FdoConnectionState_Closed">
00033 /// The connection is closed.
00034 /// </param>
00035 /// <param name="FdoConnectionState_Open">
00036 /// The connection is open.
00037 /// </param>
00038 /// <param name="FdoConnectionState_Pending">
00039 /// The connection is pending. this is used to indicate that the application has 
00040 /// issued an Open request, but the open is not completed because the application needs to include additional connection property values.
00041 /// </param>
00042 enum FdoConnectionState
00043 {
00044     /// The connection is busy executing one or more commands. Executing another
00045     /// command while the connection is busy will result in an exception.
00046     FdoConnectionState_Busy,
00047 
00048     /// The connection is closed.
00049     FdoConnectionState_Closed,
00050 
00051     /// The connection is open.
00052     FdoConnectionState_Open,
00053 
00054     /// The connection is open.
00055     FdoConnectionState_Pending
00056 };
00057 #endif
00058 
00059 

Comments or suggestions? Send us feedback.