Context Navigation

Changes between Version 16 and Version 17 of MapGuideRfc80

Timestamp:: Aug 17, 2009, 6:40:45 PM (15 years ago)
Author:: leaf
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

MapGuideRfc80

-              v16
+              v17
+{
 PUBLISHED_API:
+   /// \brief
+    /// Constructs an MgParameter object with a boolean vlaue.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (boolean/bool)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, bool value);
+    /// \brief
+    /// Constructs an MgParameter object with a byte vlaue.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (signed char/unsigned char/string)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, BYTE value);
+    /// \brief
+    /// Constructs an MgParameter object with an MgDateTime instance.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (MgDateTime)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, MgDateTime* value);
+    /// \brief
+    /// Constructs an MgParameter object with a float value.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (float)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, float value);
+    /// \brief
+    /// Constructs an MgParameter object with a double value.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (double)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, double value);
+    /// \brief
+    /// Constructs an MgParameter object with a 16 bits integer.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (short/int)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, INT16 value);
+    /// \brief
+    /// Constructs an MgParameter object with a 32 bits integer.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \brief
+    /// Constructs an MgParameter object.
+    ///
+    /// \param name (MgNullableProperty)
+    /// An MgNullableProperty instance which contains
+    /// the name and value of the parameter
     /// \param value (int)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, INT32 value);
+    /// \brief
+    /// Constructs an MgParameter object with a 64 bits integer.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (long/string)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, INT64 value);
+    /// \brief
+    /// Constructs an MgParameter object with a string.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value (String/string)
+    /// The value of the parameter
+    ///
+    MgParameter (CREFSTRING name, CREFSTRING value);
+    /// \brief
+    /// Constructs an MgParameter object with an MgByteReader instance.
+    ///
+    /// \param name (String/string)
+    /// The name of the parameter
+    /// \param value
+    /// The value of the parameter
+    /// \param valueType
+    /// The type of parameter value. It can be one of MgPropertyType::Blob,
+    /// MgPropertyType::Clob or MgPropertyType::Geometry.
+    ///
+    MgParameter (CREFSTRING name, MgByteReader* value, INT32 valueType);
+    /// \brief
+    /// Gets the parameter name.
+    ///
+    /// \return
+    /// Returns the parameter name.
+    ///
+    STRING GetName();  /// __get, __set
+    /// \brief
+    /// Gets the parameter type.
+    ///
+    /// \return
+    /// Returns the parameter type. See MgPropertyType.
+    ///
+    INT32 GetType();  /// __get
+    /// \brief
+    /// If set to true, disables the getting and setting of the
+    /// parameter's value. If set to false, reenables the
+    /// getting and setting of the parameter's values.
+    ///
+    /// \param bIsNull (boolean/bool)
+    /// Set to true to disable the getting and setting of
+    /// the parameter value. Set to false to reenable the
+    /// getting and setting of the parameter value.
+    ///
+    /// \return
+    /// Returns nothing.
+    ///
+    void SetNull(bool bIsNull);
+    /// \brief
+    /// Test whether the parameter value is null.
+    ///
+    /// \return
+    /// True if the parameter value is null, false Otherwise.
+    ///
+    bool IsNull();
+    /// \brief
+    /// Gets the boolean value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be
+    /// of type MgPropertyType::Boolean or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the boolean value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    bool GetBoolean();
+    /// \brief
+    /// Gets the byte value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be
+    /// of type MgPropertyType::Byte or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the byte value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    BYTE GetByte();
+    /// \brief
+    /// Gets the MgDateTime value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be
+    /// of type MgPropertyType::DateTime or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns an MgDateTime object.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    MgDateTime* GetDateTime();
+    /// \brief
+    /// Gets the float value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::Single or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the float value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    float GetSingle();
+    /// \brief
+    /// Gets the double value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::Double or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the double value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    double GetDouble();
+    /// \brief
+    /// Gets the 16 bits integer value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore the parameter must be a
+    /// of type MgPropertyType::Int16 or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the 16 bits integer value.
+    ///
+    /// \exception MgInvalidPropertyTypeException
+    ///
+    INT16 GetInt16();
+    /// \brief
+    /// Gets the 32 bits integer value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::Int32 or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the 32 bits integer value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    INT32 GetInt32();
+    /// \brief
+    /// Gets the 64 bits integer value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::Int64 or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the 64 bits integer value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    INT64 GetInt64();
+    /// \brief
+    /// Gets the string value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::String or an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the string value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    STRING GetString();
+    /// \brief
+    /// Gets the byte reader value of the parameter.
+    ///
+    /// \remarks
+    /// No conversion is performed. Therefore, the parameter must be a
+    /// of type MgPropertyType::Blob, MgPropertyType::Clob or
+    /// MgPropertyType::Geometry. Otherwise, an
+    /// MgInvalidPropertyTypeException is thrown.
+    ///
+    /// \return
+    /// Returns the byte reader value.
+    ///
+    /// \exception MgInvalidPropertyTypeException.
+    ///
+    MgByteReader* GetByteReader();
+    /// The function direction of the parameter value
+    ///
+    MgParameter (MgNullableProperty* prop, INT32 direction);
+    /// \brief
+    /// Sets the name and value of the parameter.
+    ///
+    /// \param value
+    /// Input an MgNullableProperty instance which contains
+    /// the name and value of the parameter.
+    ///
+    /// \return
+    /// Returns nothing
+    ///
+    void SetProperty(MgNullableProperty* prop);
+    /// \brief
+    /// Gets the name and value of the parameter.
+    ///
+    /// \return
+    /// Returns an MgNullableProperty instance which contains
+    /// the name and value of the parameter.
+    ///
+    MgNullableProperty* GetProperty();
     /// \brief