---
title: "startFormat(task:options:)"
framework: fskit
role: symbol
role_heading: Instance Method
path: "fskit/fsmanageableresourcemaintenanceoperations/startformat(task:options:)"
---

# startFormat(task:options:)

Starts formatting the file system with the given options.

## Declaration

```swift
func startFormat(task: FSTask, options: FSTaskOptions) throws -> Progress
```

## Parameters

- `task`: A task object you use to communicate back to the client.
- `options`: Options for performing the format.

## Return Value

Return Value An Progress object that you use to update progress as the format operation progresses. Return nil if starting to format the file system encountered an error.
