The following interfaces are used in writing SketchUp Addins. They are not part of the SketchUp Object model, but are part of the addin architecture.
More...
List of all members.
Public Member Functions |
HRESULT | HasBeenCancelled ([out] BOOL *pVal) |
| Returns whether the export has been canceled.
|
HRESULT | SetPercentDone ([in] double percent) |
| Allows the exporter to tell the progress callback what percentage is complete.
|
HRESULT | SetStepSize ([in] double percent) |
| Allows the exporter to tell the progress callback by what percent the progress should be updated with each call to step.
|
HRESULT | Step () |
| Directs the progress callback to take a step.
|
HRESULT | SetProgressMessage ([in] BSTR msg) |
| Allows the exporter to tell the progress callback what user message to present.
|
Detailed Description
The following interfaces are used in writing SketchUp Addins. They are not part of the SketchUp Object model, but are part of the addin architecture.
The IProgressCB interface lets a process report its progress back to the calling application. It also lets the calling application cancel the operation when the HasBeenCanceled method is called.
Member Function Documentation
HRESULT IProgressCB::HasBeenCancelled |
( |
[out] BOOL * |
pVal |
) |
|
Returns whether the export has been canceled.
- Return values:
-
| pVal | TRUE iff the user has canceled the export. |
- Returns:
- S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT IProgressCB::SetPercentDone |
( |
[in] double |
percent |
) |
|
Allows the exporter to tell the progress callback what percentage is complete.
- Return values:
-
| percent | The percent complete. |
- Returns:
- S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT IProgressCB::SetProgressMessage |
( |
[in] BSTR |
msg |
) |
|
Allows the exporter to tell the progress callback what user message to present.
- Return values:
-
| msg | The message to present to the user. |
- Returns:
- S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT IProgressCB::SetStepSize |
( |
[in] double |
percent |
) |
|
Allows the exporter to tell the progress callback by what percent the progress should be updated with each call to step.
- See also:
- IProgressCB::Step
- Return values:
-
| percent | The step size to use. |
- Returns:
- S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT IProgressCB::Step |
( |
|
) |
|
Directs the progress callback to take a step.
- See also:
- IProgressCB::SetStepSize
- Returns:
- S_OK : on success
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors