Edit

CVssWriterEx2::IsWriterShuttingDown method (vswriter.h)

  • Article

Determines whether the writer is shutting down.

Syntax

bool IsWriterShuttingDown();

Return value

Returns true if the writer is shutting down, or false otherwise.

Remarks

The writer implementation should call this method periodically during long-running events where the writer is performing a large amount of processing or looping. If this method returns true during the event, the writer should do the following:

  1. Log an error to the Application Event Log event. This is optional, but recommended.
  2. Call SetWriterFailure or SetWriterFailureEx, passing a non-retryable error code for the hr or hrWriter parameter.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header vswriter.h (include Vss.h, VsWriter.h)
Library VssApi.lib

See also

CVssWriterEx2