Share via

BackupToStream Method

  • Article

The BackupToStream method starts a backup of the SharePoint Portal Server to the stream.

Sub BackupToStream( _pStream As Object, _
  bstrPassword As String _ )[C++]
HRESULT BackupToStream(
  IUnknown* pStream,
  BSTR bstrPassword);

[Visual Basic]

Parameters
  • pStream
    Object containing the stream.
  • bstrPassword
    String that contains the password with which the saved data is protected. If a password is specified for the BackupToStream method, the same password must be supplied to the RestoreFromStream method when restoring from the backup image.
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
  • pStream
    [in] Pointer to the IUnknown interface that contains the stream.
  • bstrPassword
    [in] BSTR that contains the password with which the saved data is protected. If a password is specified for the BackupToStream method, the same password must be supplied to the RestoreFromStream method when restoring from the backup image.
Return Values

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

Remarks

The BackupToStream method saves all of the information in the schema, workspaces, content indexes, document store, and system configuration. There is no capability to back up a portion of the server.

BackupToStream returns after the backup job has been started. SharePoint Portal Server will be unavailable during the backup operation. Changes made during the backup might not be backed up, so it is recommended that access to the server be restricted during the backup. To check the status of backup operations in progress, use the GetBackupStatus method.