API Reference
Class
OneNoteFileProbe
Performs bounded physical-header inspection for OneNote files.
Inheritance
- Object
- OneNoteFileProbe
Methods
ReadHeader 2 overloads
public static OneNoteFileHeader ReadHeader(String path, OneNoteReaderOptions options = null) #Returns:
OneNoteFileHeaderReads a OneNote header from a file path.
Parameters
- path System.String
- options OfficeIMO.OneNote.OneNoteReaderOptions = null
public static OneNoteFileHeader ReadHeader(Stream stream, OneNoteReaderOptions options = null) #Returns:
OneNoteFileHeaderReads a OneNote header from a caller-owned stream. Seekable streams are read from the beginning and restored to their original position. Non-seekable streams are consumed only through the physical header prefix.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OneNote.OneNoteReaderOptions = null
ReadHeaderAsync 2 overloads
public static async Task<OneNoteFileHeader> ReadHeaderAsync(String path, OneNoteReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OneNoteFileHeader>Asynchronously reads a OneNote header from a file path.
Parameters
- path System.String
- options OfficeIMO.OneNote.OneNoteReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
public static Task<OneNoteFileHeader> ReadHeaderAsync(Stream stream, OneNoteReaderOptions options = null, CancellationToken cancellationToken = null) #Returns:
Task<OneNoteFileHeader>Asynchronously reads a OneNote header from a caller-owned stream. Seekable streams are restored to their original position after the read.
Parameters
- stream System.IO.Stream
- options OfficeIMO.OneNote.OneNoteReaderOptions = null
- cancellationToken System.Threading.CancellationToken = null
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object