ISelectObjectCmd::Initialize

CAUTION Customers should only use the ISelectObjectCmd2::Initialize2 method in new development, as well as replace existing implementations of the ISelectObjectCmd::Initialize method with ISelectObjectCmd2::Initialize2 . The following information describes the method as it was defined in FileNet P8 3.0.0 and is provided for informational purposes only. FileNet does not support development with the ISelectObjectCmd::Initialize method in FileNet P8 3.5.0 or later.

The Initialize method customizes the Select Item Java™Server Pages (JSP) page in preparation for use by the SelectObject operation, by allowing the client application to filter the list of selectable items that are presented to the user (based on object type and MIME type), and to specify the page title.

void spISelectObjectCmd->Initialize(_bstr_t bstrPageTitle,
                                    SelectItemMode enMode,
                                    VARIANT vMimeTypes);
Parameters
bstrPageTitle - [in] Required _bstr_t, which specifies the label to display in the title bar of the Select Item JSP page when the SelectObject command is invoked. By using this parameter, client applications can customize the title that appears at the top of the JSP page to correspond with their application requirements.
enMode - [in] Required SelectItemMode enumeration, which specifies the selection mode for the SelectObject operation and can be set to the following:
- eFoldersAndDocumentsMode, select either a document or a folder.
- eDocumentsOnlyMode, select only a document.
- eFoldersOnlyMode, select only a folder.
- eAllObjectTypesMode, select any type of object, including documents and folders.
vMimeTypes - [in] Required pointer to a VARIANT, which specifies a SAFEARRAY of the possible MIME types for which to generate the list of selectable items. When all MIME types are allowed, a value of VT_EMPTY should be specified.
Results
This method always returns an HRESULT value of S_OK if successful.
Sample
For a demonstration of how to use the SelectObject command in FileNet P8 3.5.0 or later, see the complete example for the command.