IMessenger::OptionsPages method

Article
05/31/2018

[OptionsPages is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

Launches the Options dialog box with a specified tab displayed.

Syntax

HRESULT OptionsPages(
  [in] long        hwndParent,
  [in] MOPTIONPAGE mOptionPage
);

Parameters

hwndParent [in]

Type: long

A LONG. Reserved. Implementations should set this parameter to 0 or NULL.

mOptionPage [in]

Type: MOPTIONPAGE

A value of the MOPTIONPAGE enumeration. Allowed values are as follows:

Constant	Value	Description
MOPT_GENERAL_PAGE	0	Displays the General tab of the Options dialog box (default).
MOPT_PRIVACY_PAGE	1	Displays the Privacy tab of the Options dialog box.
MOPT_EXCHANGE_PAGE	2	Displays the Exchange tab of the Options dialog box. Because this tab does not exist in the version 4.0 client, this value should not generally be used. Service configuration information appears in the Accounts tab of the version 4.0 client.
MOPT_ACCOUNTS_PAGE	3	Displays the Accounts tab of the Options dialog box.
MOPT_CONNECTION_PAGE	4	Displays the Connection tab of the Options dialog box.
MOPT_PREFERENCES_PAGE	5	Displays the Preferences tab of the Options dialog box.
MOPT_SERVICES_PAGE	6	Displays the Services tab of the Options dialog box. This tab is enabled only on a client that can use multiple services.
MOPT_PHONE_PAGE	7	Displays the Phone tab of the Options dialog box.

Return value

Type: HRESULT

For a table of MSGR_E_* constants, see MSGRConstants.

Returns one of the following values.

Return code	Description
S_OK	Success.
E_FAIL	Could not create the Options dialog box, or the Messenger object has not been created or is not responding.
E_FALSE	The Options dialog box is already open. The second call will change the mOptionPage value (Option tab) in the foreground if the value is different. S_FALSE cannot usually be captured in scripting error trapping because the initial error bit is not 1 in this HResult.
MSGR_E_AUDIO_UI_ACTIVE	Called this method while the Media Wizard dialog box was enabled and visible.
MSGR_E_CONTACT_UI_ACTIVE	The Add a Contact or Find a Contact dialog box of the Messenger client (modal dialog box) is currently open.
MSGR_E_LOGON_UI_ACTIVE	The Sign In dialog box of the Messenger client (modal dialog box) is currently open.
MSGR_E_OTHER_UI_ACTIVE	Called this method while the Customer Experience Improvement Program(CEIP) dialog box was enabled and visible.

Remarks

Because some options can be checked or changed while the client is offline, this method does not fail for offline clients. However, some of the dialog boxes will initially display a grayed-out UI for an offline local client use

Note

This method is available for scripting languages.

Requirements


End of client support	Windows XP
End of server support	Windows Server 2003
Header	Msgrua.h
IDL	Msgrua.idl
DLL	Msgsc.dll

Share via