Changes between Version 30 and Version 31 of FDORfc33

Timestamp:

Apr 16, 2009, 9:52:21 AM (15 years ago)

Author:

gregboone

Comment:

--

FDORfc33

@@ -48 +48 @@
 TODO: 
 
--- Figure out how providers can determine what are input/output parameters[[BR]]
--- Procedure calls, input/output parameters, etc....[[BR]]
--- Examples[[BR]]
+-- Examples
 
 == Requirements ==
@@ -83 +81 @@
 }}}
 
+
+==== FdoParameterDirection Enumeration ====
+
+A new enumeration, !FdoParameterDirection, will be added to the FDO API for use within FDO Commands that utilize parameters. !FdoParameterDirection defines the direction in which the command will utilize the parameter upon execution. Parameter direction values are typically Input, Output, InputOutput and Return, with the  default value is typically Input.
+
+{{{
+/// \brief
+/// The FdoParameterDirection enumeration defines the direction in which a
+/// Parameter value will be used within the context of an FDO Command. Parameter 
+/// Direction values are typically Input, Output, InputOutput and Return. 
+/// The default value is typically Input.
+enum FdoParameterDirection 
+{
+    FdoParameterDirection_Input,
+    FdoParameterDirection_Ouput,
+    FdoParameterDirection_InputOutput,
+    FdoParameterDirection_Return
+};
+}}}
+
+==== Parameter Value Interface ====
+
+The !FdoParameterValue class will be updated to add an additional property Direction, which will indicate the direction in which the parameter will be used within the context of command using the parameters within the context of their execution.
+
+/// \brief
+/// The FdoParameterValue class specifies a value for a particular parameter.
+/// Instances of this class are used to specify a value to bind to a parameter
+/// when a command is executed.
+class FdoParameterValue : public FdoIDisposable
+{
+public:
+...
+...
+...
+    /// \brief
+    /// Sets the function direction of the parameter value.
+    /// Values can be Input, Output, InputOutput and Return.
+    /// 
+    /// \param value 
+    /// Input the direction enumeration value
+    /// 
+    /// \return
+    /// Returns nothing
+    /// 
+    FDO_API void SetDirection(FdoParameterDirection value);
+
+    /// \brief
+    /// Gets the function direction of the the command parameter.
+    /// Values can be Input, Output, InputOutput and Return.
+    /// 
+    /// \return
+    /// Returns the direction enumeration value
+    /// 
+    FDO_API FdoParameterDirection GetDirection();
+};
 
 ==== SQLCommandType Enumeration ====