IDASite Interface

The IDASite interface supports managing global information that can apply to more than one view. Information about importing media files, for example, can apply to more than one view. Microsoft® DirectAnimation® sends status information to IDASite, and you can use the IDASite methods to retrieve it.

You can access the site object through the Site property in DAStatics.

This interface inherits from IDispatch. Like pure COM interfaces, such as IUnknown, IDispatch exposes objects, methods, and properties to applications. Unlike IUnknown, IDispatch members are identified with human-readable names, not as vtable indexes. IDispatch interfaces don't perform as well as pure COM interfaces.

The IDAViewSite interface supports managing information that is tied to a view.

IDASite Methods

ReportError Sends a message reporting the specified error.

ReportGC Sends a message that garbage collection is about to start, or that garbage collection has just finished.
SetStatusText Sets the global status text.

IDASite::ReportError

IDASite

Sends a message reporting the specified error.

Syntax

HRESULT ReportError(
    HRESULT hr,
    BSTR ErrorText
);

Parameters

hr
[in] HRESULT value of the error.
ErrorText
[in] BSTR value containing the error text.

Return Value

Returns an HRESULT value that indicates the success of the method or the reason why it failed. This HRESULT depends on the implementation of the interface.

IDASite::ReportGC

IDASite

Sends a message that garbage collection is about to start, or that garbage collection has just finished.

Syntax

HRESULT ReportGC(
    VARIANT_BOOL bStarting
    );

Parameters

bStarting

[in] Flag indicating whether garbage collection is about to start or is just finishing. If TRUE, garbage collection is about to start. If FALSE, garbage collection is just finishing.

Return Value

Returns an HRESULT value that indicates the success of the method or the reason why it failed. This HRESULT depends on the implementation of the interface.

IDASite::SetStatusText

IDASite

Sets the global status text.

Syntax

HRESULT SetStatusText(
    BSTR StatusText
);

Parameters

StatusText

[in] BSTR value containing the status text for the site. A BSTR is a length-prefixed string. The length is stored as an integer at the memory location preceding the data in the string.

Return Value

Returns an HRESULT value that indicates the success of the method or the reason why it failed. This HRESULT depends on the implementation of the interface.

Remarks

For an example of this method, see ctlhost.cpp in the Samples\Multimedia\DAnim\C++\Showcase\DragGeoCntrl directory.

ReportError	Sends a message reporting the specified error.
ReportGC	Sends a message that garbage collection is about to start, or that garbage collection has just finished.
SetStatusText	Sets the global status text.