IMAPIForm::SetViewContext

The IMAPIForm::SetViewContext method establishes a view context for the form.

Quick Info

See IMAPIForm : IUnknown.

HRESULT SetViewContext(
  LPMAPIVIEWCONTEXT pViewContext  
);
 

Parameters

pViewContext

[in] Pointer to the new view context for the form.

Return Values

S_OK

The view context was successfully set.

Remarks

Form viewers call the IMAPIForm::SetViewContext method to establish a particular form view context as current. A form can have only one view context at a time.

Notes to Implementers

Most form servers implement SetViewContext using this algorithm:

• If a view context already exists for the form, cancel the form's registration by calling the IMAPIViewContext::SetAdviseSink method with NULL in the pmnvs parameter, and then call the view context's Release method to decrement its reference count.
• If the new view context is not NULL, call IMAPIViewContext::SetAdviseSink using the pViewContext parameter to set up a new view advise sink.
• If the new view context is not NULL, call the IMAPIViewContext::GetViewStatus method to determine which status flags have been set.
• If the new view context is not NULL, store it and call its AddRef method to increment its reference count.
• Update any user interface elements that depend on the view context.

Depending on the status flags returned from GetViewStatus, SetViewContext can also perform other actions. For example, if the VCSTATUS_NEXT and VCSTATUS_PREV flags are returned, SetViewContext can enable the Next and Previous buttons for the new view context.