Share via

Backup Method

  • Article

The Backup method starts a backup of the SharePoint Portal Server.

Sub Backup( _bstrPath As String, _
  bstrPassword As String _ )[C++]
HRESULT Backup(
  BSTR bstrPath,
  BSTR bstrPassword);

[Visual Basic]

Parameters
  • bstrPath
    String that contains the file-system folder where the backup information is stored. The bstrPath parameter can accept a local file system or universal naming convention (UNC) path.
  • bstrPassword
    String that contains the password with which the saved data is protected. If a password is specified for the backup, the same password must be supplied to the Restore 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
  • bstrPath
    [in] BSTR that contains the file-system folder where the backup information is stored. The bstrPath parameter can accept a local file system or universal naming convention (UNC) path.
  • bstrPassword
    [in] BSTR that contains the password with which the saved data is protected. If a password is specified for the backup, the same password must be supplied to the Restore 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 Backup 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.

Backup 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.