IPropertyProxyEESide::InPlaceUpdateObject

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Updates the object's data with the given data object and returns a new data object representing the object's new data.

Syntax

HRESULT InPlaceUpdateObject(  
   [in] IEEDataStorage*   dataIn,  
   [out] IEEDataStorage** dataOut  
);  

int InPlaceUpdateObject(  
   IEEDataStorage     dataIn,  
   out IEEDataStorage dataOut  
);

Parameters

dataIn
[in] An IEEDataStorage object containing the new data.

dataOut
[out] Returns a new IEEDataStorage object containing the replaced data.

Return Value

If successful, returns S_OK; otherwise, returns an error code.

Remarks

This method actually updates the object's data. The data in the returned IEEDataStorage object does not need to be the same as the data in the incoming IEEDataStorage object, but the returned object must reflect the property's current value.

The incoming data object is typically not implemented by the EE. However, the object returned by this method is always implemented by the EE, which lets the EE implement the IEEDataStorage interface on whatever class is desired.

The CreateReplacementObject method creates a data object based on the incoming data object but does not affect the property's original data.

See Also

IPropertyProxyEESide
IEEDataStorage
CreateReplacementObject