IMAPIForm::GetViewContext

The IMAPIForm::GetViewContext method returns the current view context for the form.

Quick Info

See IMAPIForm : IUnknown.

HRESULT GetViewContext(
  LPMAPIVIEWCONTEXT FAR * ppViewContext  
);
 

Parameters

ppViewContext

[out] Pointer to a pointer to the form's view context.

Return Values

S_OK

The form's current view context was successfully returned.

S_FALSE

There is no view context for the form.

Remarks

Form viewers call GetViewContext to obtain a pointer to the view context established in a previous call to IMAPIForm::SetViewContext. If no prior call has been made to SetViewContext, GetViewContext sets ppViewContext to NULL.

Notes to Implementers

Copy your form's view context pointer into the pointer passed in by the calling form viewer in the ppViewContext parameter. If your form does not have a view context, set ppViewContext to NULL.

See Also

IMAPIViewContext : IUnknown