IMsgrLock::SendResponse method

Article
05/31/2018

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

Sends authentication data from a Messenger client to a Messenger service .

Syntax

HRESULT SendResponse(
  [in] BSTR bstrAppStrId,
  [in] BSTR bstrResponse,
  [in] long lCookie
);

Parameters

bstrAppStrId [in]

Type: BSTR

BSTR that identifies the application's ID.

bstrResponse [in]

Type: BSTR

BSTR that has been generated by an MD5. See Remarks for more information.

lCookie [in]

Type: long

LONG that identifies the transaction session.

Return value

Type: HRESULT

Returns one of the following values.

Return code	Description
S_OK	The response was sent successfully.
E_FAIL	The response has failed due to a catastrophic error.
E_INVALIDARG	One of the parameters passed to the method was not valid.
MSGR_E_API_NOTINITIALIZED	The Messenger client lock and key mechanism is not initialized.
MSGR_E_API_LOCKED	The Messenger service API is locked.
MSGR_E_API_PENDING_UNLOCK	The application timed out while waiting for the result of the challenge.
MSGR_E_API_UNLOCK_FAILED	The application response to the challenge failed.
MSGR_E_API_ALREADY_UNLOCKED	The Messenger service API is already unlocked.

Remarks

The OnLockChallenge event is fired when a Messenger service responds to a Messenger client request challenge. This event returns two parameters. The first parameter is a LONG that identifies a cookie. This cookie is passed to the Messenger service when the Messenger client initiates a challenge request with the RequestChallenge method. The second parameter is a BSTR, which is generated by the Messenger service . For more information, see the overview on the Messenger Lock and Key API.

The following table lists the error codes returned by this method.

Error Code	Meaning
0x80000003	One of the parameters passed to the method was not valid.
MSGR_E_API_NOTINITIALIZED (0x81000751)	The Messenger client lock and key mechanism is not initialized.
MSGR_E_API_LOCKED (0x81000752)	The Messenger service API is locked.
MSGR_E_API_UNLOCK_FAILED (0x81000753)	The application response to the challenge failed.
MSGR_E_API_ALREADY_UNLOCKED (0x81000754)	The Messenger service API is already unlocked.
MSGR_E_API_PENDING_UNLOCK (0x81000755)	The application timed out while waiting for the result of the challenge.
0x80004005	The response has failed due to a catastrophic error.

Requirements


Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
End of client support	Windows XP
End of server support	Windows Server 2003
Product	Messenger 4.5
Header	Msgrpriv.h
IDL	Msgrpriv.idl
DLL	Msgsc.dll