Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Public Member Functions | Properties

ISupportExporterAbout Interface Reference

An optional interface supported by an exporter. More...

List of all members.

Public Member Functions

HRESULT DoAbout ()
 Directs this object to present its own About Box.

Properties

BOOL SupportsAboutBox [get]
 Query to determine whether this object supports its own About Box.
BSTR AboutString [get]
 Returns a descriptive string about the exporter.

Detailed Description

An optional interface supported by an exporter.

If this interface is supported, then the exporter can either present its own About Box, or minimally can provide a descriptive string.

See also:
ISketchUpExporter

Member Function Documentation

HRESULT ISupportExporterAbout::DoAbout (  ) 

Directs this object to present its own About Box.

Returns:
S_OK : if successful
S_FALSE : If the object does not provide its own About Box
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

Property Documentation

BSTR ISupportExporterAbout::AboutString [get]

Returns a descriptive string about the exporter.

Regardless of whether this object supports its own about box, it should be able to provide this descriptive string.

The format of the string should be:

Exporter_Name\nExporter_Description

where the Exporter_Name is a string not containing the \n character and the Exporter_Description section can contain multiple lines.

Return values:
pAboutString The descriptive string.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BOOL ISupportExporterAbout::SupportsAboutBox [get]

Query to determine whether this object supports its own About Box.

The alternative to supporting its own About Box is to simply provide a descriptive string.

See also:
ISupportExporterAbout::DoAbout
ISupportExporterAbout::AboutString
Return values:
pSupports TRUE iff this object supports its own about box.
Returns:
S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

©2010 Google - Google Home - About Google