IPM
AbstractStream Class Reference
Inheritance diagram for AbstractStream:
Inheritance graph

Public Member Functions

_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 

Public Attributes

 Contents
   More...
 
 Hash
   More...
 
 LastModifiedTimestamp
   More...
 
 Name
   More...
 

Static Private Member Functions

_.Library.Status LockName (_.Library.String pName, _.Library.Boolean pShared, _.Library.Integer pTimeout)
 Given a document name (including extension), lock it and report a descriptive error if the lock fails.
 
_.Library.Status UnlockName (_.Library.String pName, _.Library.Boolean pShared, _.Library.Boolean pImmediate)
 Given a document name (including extension), unlock it.
 
_.Library.Status ValidateName (_.Library.String pName, _.Library.String pLogicalName)
 Ensures that pName is a valid Studio document name (including / based on extension) for this stream class.
 

Member Function Documentation

◆ OnAddToSaveSet()

_.Library.Status OnAddToSaveSet ( _.Library.Integer  depth,
_.Library.Integer  insert,
_.Library.Integer  callcount 
)

This callback method is invoked when the current object is added to the SaveSet,.

either because Save() was invoked on this object or on an object that references this object. OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking AddToSaveSet or remove objects by calling RemoveFromSaveSet.

If this method returns an error status then Save() will fail and the transaction will be rolled back.

Member Data Documentation

◆ Contents

Contents

 

 

◆ Hash

Hash

 

 

◆ LastModifiedTimestamp

LastModifiedTimestamp

 

 

◆ Name

Name