IMessenger2::ContactsSortOrder Property

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

Sets or retrieves the current sort order for the local client, which is used to determine if the contacts should be sorted by groups or by their online/offline status.

This property is read/write.

Syntax (put)

HRESULT put_ContactsSortOrder(
  [in]           MUASORT Sort
);

Parameters

Sort [in]

Syntax (get)

HRESULT get_ContactsSortOrder(
  [out, retval]  MUASORT *pSort
);

Parameters

pSort [out]

Sets or retrieves the current sort order for the local client.

Return Value

Returns one of the following values:

Return codeDescription
S_OK

Success.

E_INVALIDARG

MUASORT is out of range.

E_FAIL

The Messenger application window is closed.

MSGR_E_NOT_LOGGED_ON

The local client is not logged on.

MSGR_E_GROUPS_NOT_ENABLED

Groups are not supported.

RPC_X_NULL_REF_POINTER

pSort is a NULL pointer.

 

Remarks

Some services, such as Microsoft Exchange� Instant Messaging Service (IM), do not support groups. The use of this property on these services will return the error MSGR_E_GROUPS_NOT_ENABLED.

Note  The following remarks apply to scripting languages. The get_ContactsSort property is available for scripting languages; put_ContactsSort is not.

Requirements

Header

Msgrua.h

IDL

Msgrua.idl

DLL

Msgsc.dll

See Also

IMessenger2

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2010

Show: