RetrieveStatus

Retrieves an XML representation of the specified historical run of the referenced recovery plan. This XML document is transmitted in chunks limited by the maximum length of a string in the transport layer. You specify what line to start at and how many lines to return.

Synopsis

String[] retrieveStatus(int key, int offset, int maxLines)

key is the unique key for the plan history, returned in RecoveryResult.key from getGetRecoveryResult.

offset is an integer specifying the starting line number in the XML file, beginning at 0,

maxLines is an integer specifying the maximum number of lines to retrieve.

Returns a string containing an XML representation of all recovery steps and their results.

Only after you have retrieved all the lines and assembled them do you have a valid XML document.

Faults

  • InvalidArgument, if the offset exceeds the length of the document or if maxLines is not positive.
  • RecoveryResultNotFound, if no result with that key exists.
  • RuntimeFault

Example for RetrieveStatus

*recoveryhistory = _service.RetrieveStatus(_srm.history, key, offset, lines);