Share via

IEEVisualizerDataProvider::SetObjectForVisualizer

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. 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

This method changes the object that the visualizer represents.

Syntax

HRESULT SetObjectForVisualizer(
   IDebugObject*  pNewObject,
   BSTR*          error,
   IDebugObject** pException
);

int SetObjectForVisualizer(
   IDebugObject     pNewObject,
   out string       error,
   out IDebugObject pException
);

Parameters

pNewObject
[in] The object to set.

error
[out] If there was an error setting the object, this string holds the error message.

pException
[out] If there was an error, this object holds the exception information.

Return Value

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

Remarks

It is up to the implementer to determine how error information is returned. However, it is possible that some callers may only look to see if an exception object was returned to know there was an error, so this method should always return an exception object if there was an error. The error string should also be supplied in case the caller wants to make use of it.

See also