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

Public Member Functions

ISupportExporterValidation Interface Reference

An optional interface supported by an exporter so that the exporter can "opt-out" of being used. More...

List of all members.

Public Member Functions

HRESULT IsValid ([in]IUnknown *activeDocument,[out, retval]BOOL *pIsValid)
 Allows the exporter to decide if it is valid with the given document.

Detailed Description

An optional interface supported by an exporter so that the exporter can "opt-out" of being used.

Supporting this interface gives the application the opportunity to decide whether it is valid in this session. For example, if an exporter depends on a certain library being available and licensed, that check can be performed during the IsValid call, and if the conditions are not right, this exporter can report back that it is not valid. In this case, the application will not present this exporter as an option.

This interface can be supported either by ISketchUpExporter or IEnumSketchUpExporter implementing objects.

See also:
ISketchUpExporter

Member Function Documentation

HRESULT ISupportExporterValidation::IsValid ( [in] IUnknown *  activeDocument,
[out, retval] BOOL *  pIsValid 
)

Allows the exporter to decide if it is valid with the given document.

Parameters:
activeDocument A ISkpDocument that represents the document to be written.
pIsValid Set to TRUE on return iff this exporter is valid in this session.
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