IMessenger::Page Method

[Page is no longer available in Windows Vista. See Windows Messenger for more information.]

Launches the Page window that is used to page a user, as designated by the input parameter.

Syntax

HRESULT Page(
  [in]           VARIANT vContact,
  [out, retval]  IDispatch **ppMWindow
);

Parameters

vContact [in]
VARIANT

A VARIANT that can take as its value either a VT_BSTR string or a VT_DISPATCH pointer to an existing MessengerContact object. If the input value type is a string, this method creates a new MessengerContact object internally. The string should be the full sign-in name. For a Microsoft .NET Messenger Service contact, this should include the "@" symbol and domain name. If the input value type is a pointer to an existing MessengerContact object (should be type VT_DISPATCH), the existing object is used.

ppMWindow [out]
IDispatch

A pointer to a pointer to the IDispatch interface on a MessengerWindow object, which can be accessed through the IMessengerWindow interface that is used to call other automation-accessible properties, such as Height, Width, Top, Left, and Show.

Return Value

HRESULT

For a table of all MSGR_E_* constants MSGRConstants, see.

Returns one of the following values:

Return codeDescription
S_OK

Success.

MSGR_E_PAGING_UNAVAILABLE

Could not initiate paging. This contact does not have mobile services enabled. The remote client must configure mobile services through its client options UI before this call will succeed.

RPC_X_NULL_REF_POINTER

ppMWindow is a NULL pointer.

E_INVALIDARG

vContact is NULL, points to a NULL string, or points to a string that has a space as the first character.

- or -

vContact is a VT_BSTR that exceeded 129 characters.

- or -

vContact is a VT_BSTR and contains a carriage return or linefeed.

MSGR_E_NOT_LOGGED_ON

Client was not signed in the primary service at the time this method was called.

E_FAIL

Could not create an Instant Message window.

- or -

Called this method while the Sign In dialog box was enabled and visible.

- or -

Called this method against the local client user.

 

Remarks

The Microsoft Exchange� Instant Messaging Service (IM) service cannot support this method. Calling this method on an Exchange service contact will fail.

To use this method with Windows Messenger, you must install an add-in component that supports paging.

ppMWindow should be released when it is no longer needed.

Note  This method is available for scripting languages but it returns E_NOTIMPL.

Requirements

Header

Msgrua.h

IDL

Msgrua.idl

DLL

Msgsc.dll

See Also

IMessenger
InstantMessage

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2010

Show: