Purpose:
This is the class that is used to represent an XDO for OD. A BLOB (XDO) represents the base or annotation part of an OnDemand document.
Methods:
init(LPDISPATCH datastore);
If this method is used it must be called following the creation of a DXBlobOD object (except for methods returning a DXBlobOD object). Initialize xdo with the datastore from OD. The input parameter LPDISPATCH pointer contains a DXDatastoreOD object.
addExtension(LPDISPATCH extensionObj);
Add 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 DXAnnotationOD object or a DXViewDataDefOD object or a DXFixedViewDataOD object.
LPDISPATCH datastore();
Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreOD 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.
OnDemand only supports the deletion of annotations, not documents.
long getAffiliatedType();
Gets the affiliated type. For OnDemand, the possible affiliated types are DX_OD_BASE or DX_OD_ANNOTATION.
long getAffiliatedType();
Gets the affiliated type. For OnDemand, the possible affiliated types are DX_OD_BASE or DX_OD_ANNOTATION.
BSTR getContent();
long getContentClass();
getContentToClientFile(LPCTSTR filename, long fileOption);
Copies the lob data content of this object to the named file.
LPDISPATCH getExtension(LPCTSTR extensionName);
Gets the extension object for this object. The returned LPDISPATCH pointer contains a DXAnnotationOD object, or a DXViewDataDefOD or a DXFixedViewDataOD. Valid extension names are:
BSTR getMimeType();
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 DXPidXDOOD object.
long getRank();
long getSize();
Gets the size of the object content from the datastore. It will not retrieve the object content from the datastore.
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.
removeExtension(LPDISPATCH extensionObj);
Remove the extension object from this object. The input parameter LPDISPATCH pointer contains a DXStorageManageInfoOD object.
retrieve();
Retrieves the persistent data of this object from the datastore. The object content identified by its PID, will be retrieved from the datastore to the memory buffer of this object.
setAffiliatedType(long affiliatedType);
Sets the affiliated type of the object. For OnDemand, the possible affiliated types are DX_OD_BASE or DX_OD_ANNOTATION.
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.
setExtension(LPDISPATCH extensionObj);
Sets the extension object for this object. The input parameter LPDISPATCH pointer contains a DXAnnotationOD object or a DXViewDataDefOD object or a DXFixedViewDataOD object. Valid extension object names are:
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 DXPidXDOOD object.
setRank(long rank);
Sets the ranking value of a query
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.