dotnet / dotnet/dotnet-api-docs

Incorrect summary

Open
#1,523 2 comments 0 reactions 0 assignees View on GitHub
area-Microsoft.Win32 dotnet-api/prod Pri2 waiting-on-feedback
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

The summary for this item says "Provides a safe handle that represents a memory-mapped file ***for sequential access***." [error emphasized]

This is incorrect, this `SafeFileHandle` type is used for the `MemoryMappedFile` handle itself, not one of the `MemoryMappedView` types that it spawns. Only the latter are described as either "random access" (`MemoryMappedViewAccessor`) versus "sequential access" (`MemoryMappedViewStream`).

The `MemoryMappedFile` itself is agnostic on this distinction and not itself committed to "sequential access" as the summary states.

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 5e61a9c9-363a-42e6-e690-ebf4b422d915
* Version Independent ID: bddc61fb-00f8-6e48-be12-4da16aeeecb8
* Content: [SafeMemoryMappedFileHandle Class (Microsoft.Win32.SafeHandles)](https://docs.microsoft.com/en-us/dotnet/api/microsoft.win32.safehandles.safememorymappedfilehandle?view=netframework-4.7.2)
* Content Source: [xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Win32.SafeHandles/SafeMemoryMappedFileHandle.xml)
* Product: **dotnet-api**
* GitHub Login: @mairaw
* Microsoft Alias: **mairaw**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.