IServerClient::SendMultipleMessage method

---

Sends an instant message to several users and/or messaging groups at the same time.

HRESULT SendMultipleMessage(
    LPDWORD lpTranferMultipleMessageStruct,
    LPDWORD lpMultipleRecipientsArray,
    LPDWORD lpdwExtendedCode
);

Parameters

lpTranferMultipleMessageStruct

[in] Pointer to a TRANSFER_MULTIPLE_MESSAGE_STRUCT structure that contains information on the instant message.

lpMultipleRecipientsArray

[in] Pointer to an array of MULTIPLE_RECIPIENT_STRUCT structure that contains recipients of the message.

lpdwExtendedCode

[out] Pointer to a DWORD variable that gets an extended code if error result is returned. For available codes see Available Extended Codes topic.

Return Value

S_OK

The function was successful. Check lpdwExtendedCode variable to get extended information.

E_INVALIDARG

One or more arguments are incorrect.

E_FAIL

Some error occurred in the function. Check lpdwExtendedCode variable to get extended information on the error.

Remarks

The lpszMessageKey member of the pointed TRANSFER_MULTIPLE_MESSAGE_STRUCT contains a unique key if the call of the method is succeeded. That value can be used to identify the outgoing instant messaging in the application.

The nRecipientsCount member of the TRANSFER_MULTIPLE_MESSAGE_STRUCT structure pointed to by the lpTransferMultipleMessageStruct variable must contain the number of elements of the array pointed to by the lpMultipleRecipientsArray member.