IMAPIFormMgr::OpenFormContainer
The IMAPIFormMgr::OpenFormContainer
method opens an IMAPIFormContainer interface for a specific form
container.
Quick Info
See IMAPIFormMgr
: IUnknown.
HRESULT OpenFormContainer(
|
HFRMREG hfrmreg,
|
|
|
LPUNKNOWN lpunk, |
|
|
LPMAPIFORMCONTAINER FAR * lppfcnt |
|
|
) |
|
Parameters
hfrmreg
[in] HFRMREG
enumeration indicating the form library to open that is, the form container to open. An HFRMREG enumeration
is an enumeration specific to a form library provider. Possible HFRMREG values
include:
HFRMREG_DEFAULT
Convenient
form container.
HFRMREG_FOLDER
Folder
container.
HFRMREG_PERSONAL
Container for
the default message store.
HFRMREG_LOCAL
Local form
container.
lpunk
[in] Pointer
to the object for which the interface is opened. The lpunk parameter
must be NULL unless the value for the hfrmreg parameter requires an
object pointer.
lppfcnt
[out] Pointer
to a pointer to the returned form container object.
Return Values
S_OK
The call
succeeded and has returned the expected value or values.
MAPI_E_NO_INTERFACE
The object
pointed to by lpUnk does not support the required interface.
Remarks
Form viewers
call the IMAPIFormMgr::OpenFormContainer method to open an IMAPIFormContainer
interface for a specific form container. This interface can then be used
for installing forms into and removing forms from a form container.
Notes to Callers
If the value
in hfrmreg is HFRMREG_FOLDER, which indicates a folder container, the
interface identifier used in lpunk must be non-null and must allow QueryInterface
calls to an IMAPIFolder interface.
To open the
local form container, a call to OpenFormContainer or the MAPIOpenLocalFormContainer function must be used; the IMAPIFormMgr::SelectFormContainer method cannot be used to
enable the user to select the local form container.
See Also