class EnsLib.File.OutboundAdapter extends Ens.OutboundAdapter, EnsLib.File.Common

An Outbound Adapter class providing methods used to write data to files and do other OS level file manipulations.

Property Inventory

Method Inventory


parameter SETTINGS = RegistryID:Basic:selector?context={Ens.ServiceRegistry.External.ContextSearch/Services?Protocols_1=File},FilePath:Basic:directorySelector,Overwrite,Charset::selector?context={Ens.ContextSearch/CharacterSets},OpenTimeout;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names


property Device as %String (MAXLEN = 1000);
Property methods: DeviceDisplayToLogical(), DeviceGet(), DeviceIsValid(), DeviceLogicalToDisplay(), DeviceLogicalToOdbc(), DeviceNormalize(), DeviceSet()
property LineTerminator as %String (MAXLEN = 10) [ InitialExpression = $C(13,10) ];
Property methods: LineTerminatorDisplayToLogical(), LineTerminatorGet(), LineTerminatorIsValid(), LineTerminatorLogicalToDisplay(), LineTerminatorLogicalToOdbc(), LineTerminatorNormalize(), LineTerminatorSet()
property OldIO as %String (MAXLEN = 1000);
Property methods: OldIODisplayToLogical(), OldIOGet(), OldIOIsValid(), OldIOLogicalToDisplay(), OldIOLogicalToOdbc(), OldIONormalize(), OldIOSet()
property OpenTimeout as %Numeric (MINVAL = 0) [ InitialExpression = 5 ];
Number of seconds to wait on each attempt to open the output file.
Property methods: OpenTimeoutDisplayToLogical(), OpenTimeoutGet(), OpenTimeoutIsValid(), OpenTimeoutLogicalToDisplay(), OpenTimeoutNormalize(), OpenTimeoutSet()
property Overwrite as %Boolean [ InitialExpression = 0 ];
Overwrite file if it exists, instead of appending
Property methods: OverwriteDisplayToLogical(), OverwriteGet(), OverwriteIsValid(), OverwriteLogicalToDisplay(), OverwriteNormalize(), OverwriteSet()


method CreateFilename(pFilename As %String, pSpec As %String, pIsVMS As %Boolean, pDirectory As %String, pLocal As %Boolean) as %String [ Language = objectscript ]
Combine base Filename with Directory and filename Spec that may contain timestamp and counter templates
method Delete(pFilename As %String) as %Status [ Language = objectscript ]
method Exists(pFilename As %String) as %Boolean [ Language = objectscript ]
method GetStream(pFilename As %String, ByRef pStream As %Stream.Object = $$$NULLOREF) as %Status [ Language = objectscript ]
method NameList(Output pFileList As %ListOfDataTypes, pWildcards As %String = "*", pIncludeDirs As %Boolean = 0) as %Status [ Language = objectscript ]
Get a list of files in the directory configured by FilePath. The filenames are returned in a %ListOfDataTypes object. Each entry in the list is a semicolon-separated string containing: Filename;Type;Size;DateCreated;DateModified;FullPathName
method OnInit() as %Status [ Language = objectscript ]
Inherited description: This user callback method is called just after %OnNew()
method PutLine(pFilename As %String, pLine As %String) as %Status [ Language = objectscript ]
method PutStream(pFilename As %String, pStream As %Stream, ByRef pLen As %Integer = -1) as %Status [ Language = objectscript ]
method PutString(pFilename As %String, pData As %String) as %Status [ Language = objectscript ]
method Rename(pFilename As %String, pNewFilename As %String, pNewPath As %String = "") as %Status [ Language = objectscript ]
method close() as %Status [ Language = objectscript ]
classmethod isTemp(pStream) [ Language = objectscript ]
method open(pFilename As %String) as %Status [ Language = objectscript ]
method openRead(pFilename As %String) as %Status [ Language = objectscript ]

Inherited Members

Inherited Properties

Inherited Methods