---
title: "read(from:options:documentAttributes:)"
framework: foundation
role: symbol
role_heading: Instance Method
path: "foundation/nsmutableattributedstring/read(from:options:documentattributes:)-5mbcx"
---

# read(from:options:documentAttributes:)

Sets the contents of the attributed string using the specified data object.

## Declaration

```swift
func read(from data: Data, options opts: [NSAttributedString.DocumentReadingOptionKey : Any] = [:], documentAttributes dict: AutoreleasingUnsafeMutablePointer<NSDictionary?>?) throws
```

```swift
func read(from data: Data, options opts: [NSAttributedString.DocumentReadingOptionKey : Any] = [:], documentAttributes dict: AutoreleasingUnsafeMutablePointer<NSDictionary?>?, error: ()) throws
```

## Parameters

- `data`: The data object providing text data.
- `opts`: Keys specifying the types of documents and other document import options. For a list of possible values, see “Option keys for importing documents” in doc://com.apple.foundation/documentation/Foundation/NSAttributedString
- `dict`: On return, the dictionary (if provided) contains keys representing various document-wide attributes. For a list of possible values, see “Document Attributes” in doc://com.apple.foundation/documentation/Foundation/NSAttributedString.
- `error`: Upon return, if an error occurs, contains an NSError object that describes the problem. If you are not interested in possible errors, pass in NULL.

## Discussion

Discussion opts can contain one of the values described in the Constants section of NSAttributedString Application Kit Additions Reference (“Option keys for importing documents”). On return, the documentAttributes dictionary (if provided) contains the various keys described in the Constants section of NSAttributedString Application Kit Additions Reference. If unsuccessful, returns NO , after setting error to point to an NSError object that encapsulates the reason why the attributed string object could not be created. note: In Swift, this method returns Void and is marked with the throws keyword to indicate that it throws an error in cases of failure. You call this method in a try expression and handle any errors in the catch clauses of a do statement, as described in Error Handling in The Swift Programming Language and About Imported Cocoa Error Parameters.

## See Also

### Reading Content

- [read(from:options:documentAttributes:)](foundation/nsmutableattributedstring/read(from:options:documentattributes:)-54wth.md)
