Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%Library] >  [FileBinaryStream]
Private  Storage   

deprecatedstream class %Library.FileBinaryStream extends %BinaryStream, %FileStreamAdaptor

Stream class that stores binary data in external files. This class is deprecated in favor of %Stream.FileBinary. For example the following code opens a file binary stream, points it at a particular file on the filesystem and then reads it in chunks of 32,000 bytes:

	Set stream=##class(%FileBinaryStream).%New()
	Set stream.Filename="c:\myfile.txt"
	While 'stream.AtEnd {
	Set line=stream.Read()
	; Process the chunk here
	}

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers


Summary

Properties
%Location AtEnd Attributes CanonicalFilename
Directory Filename Id LastModified
LineTerminator ReadSize RemoveOnClose Size

Methods
%AddToSaveSet %CheckUnique %ClassIsLatestVersion %ClassName
%ConstructClone %Delete %DeleteExtent %DeleteId
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Exists
%ExistsId %Extends %GetParameter %GetSwizzleObject
%Id %IsA %IsModified %IsNull
%KillExtent %LOBPrefetch %LocationGet %LocationSet
%LockStream %New %NormalizeObject %ObjectIsNull
%ObjectModified %ObjectSize %Oid %Open
%OpenId %OriginalNamespace %PackageName %ReleaseLock
%Reload %RemoveFromSaveSet %RollBack %Save
%SerializeObject %SetModified %UnlockStream %ValidateObject
CanonicalFilenameGet Clear CopyFrom CopyFromAndSave
DeleteAttribute DeleteStream FileBinarySize FilenameGet
FilenameSet FindAt Flush GetAttribute
GetAttributeList GetStreamId GetStreamIdForFile InputFromDevice
IsCharacter IsDefinedAttribute IsNull LastModifiedGet
LineTerminatorSet LinkToFile MoveTo MoveToEnd
NewFileName NextAttribute OpenStream OutputToDevice
OutputToDeviceAt Read ReadLine ReadLineIntoStream
ReadSQL Rewind SaveStream SerializeToSyncSet
SetAttribute SetAttributeList SizeGet StreamOIDIsNull
SyncStreamIn Write WriteLine




Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.