<!--
{
  "availability" : [
    "macOS: 15.4.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "FSKit",
  "identifier" : "/documentation/FSKit/FSBlockDeviceResource/metadataReadInto:startingAt:length:error:",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "FSKit"
    ],
    "preciseIdentifier" : "c:objc(cs)FSBlockDeviceResource(im)metadataReadInto:startingAt:length:error:"
  },
  "title" : "metadataReadInto:startingAt:length:error:"
}
-->

# metadataReadInto:startingAt:length:error:

Synchronously reads file system metadata from the resource into a buffer.

```
- (BOOL) metadataReadInto:(void *) buffer startingAt:(off_t) offset length:(size_t) length error:(NSError **) error;
```

## Parameters

`buffer`

A buffer to receive the data.

`offset`

The offset into the resource from which to start reading.

`length`

The number of bytes to read.

`error`

On return, any error encountered while reading data, or `nil` if no error occurred.

## Return Value

A Boolean value indicating whether the metadata read succeeded.

## Discussion

This method provides access to the Kernel Buffer Cache, which is the primary system cache for file system metadata.
Unlike equivalent kernel APIs, this method doesn’t hold any kernel-level claim to the underlying buffers.

For the read to succeed, requests must conform to any transfer requirements of the underlying resource.
Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets.

> Important: The Kernel Buffer Cache is keyed by offset alone and doesn’t detect overlapping byte ranges between buffers. As a result, the byte ranges of any two metadata operations must never intersect. All accesses to a given disk region must use the same (offset, length) pair.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)