Purpose:
This is the class that is used to represent an XDO for VisualInfo for AS/400. A BLOB (XDO) represents the base or annotation part of a VisualInfo for AS/400 document.
Methods:
init(LPDISPATCH datastore);
If this method is used it must be called following the creation of a DXBlobV4 object (except for methods returning a DXBlobV4 object). Initializes XDO with the datastore from VisualInfo for AS/400. The input parameter LPDISPATCH pointer contains a DXDatastoreV4 object.
add([VARIANT fileName]);
Adds this object, identified by its PID, to the datastore. If no file name is specified, then the content of this object will be added to the persistent store. If a file name is specified, then the content of the file will be added to the persistent store. The filename could be a full path name. With a very large file, this operation is more efficient than calling setContentFromClientFile, followed by add; this will serve to help avoid out-of-memory problems.
addExtension(LPDISPATCH extensionObj);
Adds the extension object for this object. The valid extension object names are the same as for setting the extension object, setExtension. The input parameter LPDISPATCH pointer contains a DXStorageManageInfoV4 or a DXAnnotationV4 object.
void changeStorage();
Changes the system-managed storage (SMS) criteria for an object.
LPDISPATCH datastore();
Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreV4 object.
del([VARIANT flushFlag]);
Deletes the persistent data of this object, identified by its PID, from the datastore. The optional parameter is in the form of BOOL. If flushFlag is true, it will clear the content (in memory), otherwise the current content will be preserved. The default is to clear the current content. The init method must be called prior to calling this method to associate the object to a datastore unless this DXDDOV4 is returned from a method.
long getAffiliatedType();
BSTR getContent();
long getContentClass();
getContentToClientFile(LPCTSTR filename, long fileOption);
Copies the LOB data content of this object to the named file.
BSTR getContentType();
BSTR getCreatedTimestamp();
LPDISPATCH getExtension(LPCTSTR extensionName);
Gets the extension object for this object. Valid extension names are:
The returned LPDISPATCH pointer contains a DXAnnotationV4 object or a DXStorageManageInfoV4 object.
BSTR getItemId();
BSTR getMimeType();
Gets the MIME type representing this object's content class.
BSTR getOpenHandler();
Gets the executable handler program name for this object instance. If no setInstanceOpenHandler call has been made for this object instance, then the class open handler will be returned. Otherwise, the instance open handler will be returned.
getOption(long option, VARIANT* value);
long getPartId();
LPDISPATCH getPidObject();
Gets the PID object. The returned LPDISPATCH pointer contains a DXPidXDOV4 object.
long getRank();
BSTR getRepType();
long getSize();
Gets the size of the object content from the datastore. It will not retrieve the object content from the datastore.
BSTR getUpdatedTimestamp();
BOOL isCategoryOf(long category);
BOOL isContentChanged();
BOOL isNull();
BOOL isOpenSynchronous();
Returns true if the open handler methods were called with true for the synchronous flag.
BOOL isSet();
long length();
open([VARIANT fileName]);
If no file name is specified, then the content of the object will be unloaded to a client file with a system generated name and then the appropriate instance or class handler will be invoked against the file. If a file name is specified, then the content of the object will be unloaded to the file specified and the appropriate instance or class handler invoked against the file. The init method must be called prior to calling this method to associate the object to a datastore unless this DXDDOV4 is returned from a method.
removeExtension(LPDISPATCH extensionObj);
Removes the extension object from this object. The input parameter LPDISPATCH pointer contains a DXAnnotationV4 or a DXStorageManageInfoV4 object.
retrieve([VARIANT fileName]);
Retrieves the persistent data of this object from the datastore. The optional parameter is in the form of a String. If no file name specified, then this object content identified by its PID, will be retrieved from the datastore to the memory buffer of this object. If a file name is specified, then the content of this object will be retrieved from the datastore to the specified file, which can be an absolute pathname. For a very large object, this will serve to help avoid out-of-memory problems. The init method must be called prior to calling this method to associate the object to a datastore unless this DXDDOV4 is returned from a method.
setAffiliatedType(long affiliatedType);
setClassOpenHandler(LPCTSTR aHandler, BOOL newSynchronousFlag);
Sets the executable handler program name, and whether this handler should be invoked synchronously or asynchronously for the class.
setContent(LPCTSTR content);
setContentClass(long aContentClass);
setContentFromClientFile(LPCTSTR filename);
Sets the content LOB data from the contents of the given file.
setContentType(LPCTSTR contentType);
setExtension(LPDISPATCH extensionObj);
Sets the extension object for this object. The input parameter LPDISPATCH pointer contains a DXStorageManageInfoV4 or a DXAnnotationV4 object.
setInstanceOpenHandler(LPCTSTR aHandler, BOOL newSynchronousFlag);
Sets the executable handler program name, and whether this handler should be invoked synchronously or asynchronously for this object instance.
setItemId(LPCTSTR itemId);
setMimeType(LPCTSTR mimeType);
setNull();
setOption(long option, VARIANT value);
setPartId(long partId);
setPidObject(LPDISPATCH pidXDO);
Sets the PID object. The input parameter LPDISPATCH pointer contains a DXPidXDOV4 object.
setRank(long rank);
setRepType(LPCTSTR repType);
update([VARIANT fileName]);
Updates the persistent data of this object to the datastore. The optional parameter is in the form of a String. If no file name is specified, the object content in the datastore will be replaced with the content(in memory) of this object. If a file name is specified, then the object content in the datastore will be replaced with the content of the given file. The init method must be called prior to calling this method to associate the object to a datastore unless this DXDDOV4 is returned from a method.
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.