A scalar function that opens a stream object and returns the corresponding oref.
%OBJECT is used to open a stream object and return the oref (object reference) of the stream field.
A SELECT on a stream field returns the fully formed oid (object ID) value of the stream field. A SELECT %OBJECT on a stream field returns the oref (object reference) of the stream field.
If stream is not a stream field, %OBJECT generates an SQLCODE -128 error.
%OBJECT can be used as an argument to the following functions:
CHARACTER_LENGTH(%OBJECT(streamfield)), CHAR_LENGTH(%OBJECT(streamfield)), or DATALENGTH(%OBJECT(streamfield)).
You can perform the same operation by issuing a SELECT on a stream field, then opening the stream oid by calling the $Stream.Object.%Open()Opens in a new tab class method, which generates an oref from the oid:
SET oref = ##class(%Stream.Object).%Open(oid)
For information on orefs, see “OREF Basics”. For information on oids, see “Identifiers for Saved Objects: ID and OID” in the same book.