Share via

IMsgrSession::Application Property

  • Article

Deprecated. Obtains the application's GUID set by the inviter for this session from the registry.

Syntax

HRESULT IMsgrSession::get_Application(BSTR *pbstrAppGUID);
HRESULT IMsgrSession::put_Application(BSTR bstrAppGUID);

Parameters

  • pbstrAppGUID
    Pointer to a variable of type BSTR that retrieves the application's GUID.
  • bstrAppGUID
    BSTR that specifies the application GUID. Maximum character length is 39 characters.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The application's GUID format is {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} where X is a hexadecimal digit (0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F) and alphanumeric characters are in uppercase.

Setting bstrAppGUID to a GUID of an application not previously registered from a call to IMsgrSessionManager::RegisterApplication will cause an error. This GUID must match one of the applications already registered.

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

Error Code Meaning
E_INVALIDARG The value passed into the property was not valid.
E_OUTOFMEMORY The application ID value is too long.
SR_APP_NOT_SPECIFIED The application was not specified.
SR_SESSION_NOT_READY The session is not ready.

Important  IMsgrSession::Application is no longer available in Windows Vista. See Windows Messenger for more information.

See Also

IMsgrSessionManager::RegisterApplication, Messenger Session Invite and Messenger Private APIs, Messenger Lock and Key API