IMessengerContact::CanPage property

Article
05/31/2018

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

Retrieves a Boolean value that declares whether the contact associated with this MessengerContact object has mobile preferences established or visible.

This property is read-only.

Syntax

HRESULT get_CanPage(
  [out, retval] VARIANT_BOOL *pBoolPage
);

Property value

Pointer to a VARIANT_BOOL that declares whether this user has a defined and accessible mobile device profile. VARIANT_TRUE indicates that the user has mobile device information available. VARIANT_FALSE indicates that the user has no mobile device information available.

Error codes

Returns one of the following values.

Name	Meaning
S_OK	Success.
E_FAIL	General internal failure.
DISP_E_BADVARTYPE	Error returned by VARIANT handling library.
E_OUTOFMEMORY	Error returned by VARIANT handling library.
E_INVALIDARG	Requested an out-of-range property. This is not normally returned through this interface because the API calls a property that is known to be in range.
RPC_X_NULL_REF_POINTER	pBoolPage is a NULL pointer.

Remarks

The following table lists error codes returned by this method.

Error Code	Meaning
0x80004005	General internal failure.
0x8007000E	Error returned by VARIANT handling library.
0x80070057	Requested an out-of-range property. This is not normally returned through this interface because the API calls a property that is known to be in range.

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

Actual values used for a mobile device contact must be retrieved through other means. This method determines at the top-level only whether mobile contact information exists.

Assuming the MessengerContact object can be successfully created (which can only be done with an online client), calling this method against a MessengerContact object while the client is offline will always return pBoolPage==FALSE, even if the contact can be paged. Property information cannot be determined while offline, but will not throw an error.

Note

This property is available for scripting languages.

Examples

The following Visual Basic example shows the use of this method.

Public WithEvents MsgrUIA As MessengerAPI.Messenger
Public MsgrContact As MessengerAPI.IMessengerContact

Private Sub mnuCanPage_Click()
    On Error Resume Next
    Dim strSigninName As String
    Dim strServiceID As String
    'Get selected contact
    strSigninName = ListContact.SelectedItem.SubItems(2)
    strServiceID = ListContact.SelectedItem.SubItems(5)
    Set MsgrContact = Nothing
    Set MsgrContact = MsgrUIA.GetContact(strSigninName, strServiceID)
    ErrorTrap ("GetContact")    'Error handling routine
    If MsgrContact.CanPage = True Then
        MsgBox("Contact: " & CStr(MsgrContact.SigninName) & " can be Paged")
    Else
        MsgBox("Contact: " & CStr(MsgrContact.SigninName) & " CANNOT be Paged")
    End If
    ErrorTrap ("Contact.CanPage")   'Error handling routine
End Sub

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