Index

DXBlobV4

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:

initialization
        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
        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
        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.

changeStorage
                void    changeStorage();

Changes the system-managed storage (SMS) criteria for an object.

datastore
        LPDISPATCH datastore();

Gets the datastore. The returned LPDISPATCH pointer contains a DXDatastoreV4 object.

del
        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.

getAffiliatedType
        long getAffiliatedType();

Gets the affiliated type.

getContent
        BSTR getContent();

Gets the LOB data content.

getContentClass
        long getContentClass();

Gets the content class of the LOB data content.

getContentToClientFile
        getContentToClientFile(LPCTSTR filename, long   fileOption);

Copies the LOB data content of this object to the named file.

getContentType
         BSTR   getContentType();

Gets the content type.

getCreatedTimestamp
        BSTR getCreatedTimestamp();

Gets the date and time that the document was created.

getExtension
                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.

getItemId
         BSTR   getItemId();

Gets the item ID.

getMimeType
        BSTR getMimeType();

Gets the MIME type representing this object's content class.

getOpenHandler
        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
         getOption(long option, VARIANT* value);

Gets the value for the specified option.

getPartId
        long getPartId();

Gets the part ID.

getPidObject
        LPDISPATCH getPidObject();

Gets the PID object. The returned LPDISPATCH pointer contains a DXPidXDOV4 object.

getRank
         long   getRank();

Gets the ranking value of a query

getRepType
         BSTR   getRepType();

Gets the representaiton type that's always 8 blanks.

getSize
        long getSize();

Gets the size of the object content from the datastore. It will not retrieve the object content from the datastore.

getUpdatedTimestamp
        BSTR getUpdatedTimestamp();

Gets the date and time that the document was last updated.

isCategoryOf
         BOOL   isCategoryOf(long       category);

Returns true if the object is of a specified category.

isContentChanged
        BOOL isContentChanged();

Returns true if content has changed.

isNull
        BOOL isNull();

Returns true if object is null.

isOpenSynchronous
        BOOL isOpenSynchronous();

Returns true if the open handler methods were called with true for the synchronous flag.

isSet
        BOOL isSet();

Returns true if the content data is set.

length
        long length();

Returns the length of the LOB content of this object.

open
        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
        removeExtension(LPDISPATCH extensionObj);

Removes the extension object from this object. The input parameter LPDISPATCH pointer contains a DXAnnotationV4 or a DXStorageManageInfoV4 object.

retrieve
        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
        setAffiliatedType(long affiliatedType);

Sets the affiliated type of the object.

setClassOpenHandler
        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
        setContent(LPCTSTR content);

Sets the LOB data content.

setContentClass
        setContentClass(long aContentClass);

Sets the content class of the LOB data.

setContentFromClientFile
        setContentFromClientFile(LPCTSTR filename);

Sets the content LOB data from the contents of the given file.

setContentType
         setContentType(LPCTSTR contentType);

Sets the content type.

setExtension
        setExtension(LPDISPATCH extensionObj);

Sets the extension object for this object. The input parameter LPDISPATCH pointer contains a DXStorageManageInfoV4 or a DXAnnotationV4 object.

setInstanceOpenHandler
        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
         setItemId(LPCTSTR itemId);

Sets the item ID.

setMimeType
         setMimeType(LPCTSTR mimeType);

Sets the MIME type.

setNull
        setNull();

Sets this object to null.

setOption
         setOption(long option, VARIANT value);

Sets the option to the specified value.

setPartId
        setPartId(long partId);

Sets the part ID.

setPidObject
        setPidObject(LPDISPATCH pidXDO);

Sets the PID object. The input parameter LPDISPATCH pointer contains a DXPidXDOV4 object.

setRank
         setRank(long   rank);

Sets the ranking value of a query.

setRepType
         setRepType(LPCTSTR     repType);

Sets the representation type that must be 8 blanks.

update
        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.