IMsgrSession::Application Property

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

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

This property is read/write.

Syntax (put)

HRESULT put_Application(
  [in]           BSTR bstrAppGUID
);

Parameters

bstrAppGUID [in]

BSTR that specifies the application GUID. Maximum character length is 39 characters.

Syntax (get)

HRESULT get_Application(
  [out, retval]  BSTR *pbstrAppGUID
);

Parameters

pbstrAppGUID [out]

Pointer to a variable of type BSTR that retrieves the application's GUID.

Return Value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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 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 CodeMeaning
E_INVALIDARGThe value passed into the property was not valid.
E_OUTOFMEMORYThe application ID value is too long.
SR_APP_NOT_SPECIFIEDThe application was not specified.
SR_SESSION_NOT_READYThe session is not ready.

 

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

Error CodeMeaning
0x8007000EThe application ID value is too long.
0x80070057The value passed into the property was not valid.
SR_SESSION_NOT_READY (0x81000605)The session is not ready.
SR_APP_NOT_SPECIFIED (0x81000610)The application was not specified.

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Product

Messenger 4.0

Header

Msgrpriv.h

IDL

Msgrpriv.idl

DLL

Msgsc.dll

See Also

IMsgrSession
RegisterApplication
Messenger Session Invite and Messenger Private APIs
Messenger Lock and Key API

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2010

Community Additions

ADD
Show: