GetBackupStatus Method

  • Article

The GetBackupStatus method gets the current status of the backup and restore operations in progress.

Sub GetBackupStatus( _  pTypeBackupStatus As Long, _
  plLastError As Long, _
  pdLastTime As Variant(VT_DATE), _
  plPercentCompleted As Long _) [C++]
HRESULT GetBackupStatus(  EnumKnowledge_BackupStatus *pTypeBackupStatus,
    LONG *plLastError,
    DATE *pdLastTime,
    LONG *plPercentCompleted);

[Visual Basic]

Parameters
  • pTypeBackupStatus
    Enumeration that identifies the current type of operation, if any. Values are defined in EnumKnowledge_BackupStatus. If the pTypeBackupStatus parameter indicates that no backup or restore operation is in progress, the plLastError and ptLastTime parameters**are from a previously executed operation.
  • plLastError
    Long that contains the last error code reported by the backup or restore operation.
  • pdLastTime
    Variant that contains the date and time when the error code indicated in the plLastError parameter occurred.
  • plPercentCompleted
    Long that contains the percentage of completion of the current operation.
Return Values

None.

Error Values

If an error is raised, Err.Number is set to one of the values documented on the Error Messages page.

[C++]

Parameters
  • pTypeBackupStatus
    [out] Enumeration that identifies the current type of operation, if any. Values are defined in EnumKnowledge_BackupStatus. If the pTypeBackupStatus parameter indicates that no backup or restore operation is in progress, the plLastError and ptLastTime parameters**are from a previously executed operation.
  • plLastError
    [out] LONG that contains the last error code reported by the backup or restore operation.
  • pdLastTime
    [out] Date and time when the error code indicated in the plLastError parameter occurred.
  • plPercentCompleted
    [out] LONG that contains the percentage of completion of the current operation.
Return Values

For a list of error messages returned by SharePoint Portal Server, see Error Messages.