Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamUnifiedMessages Interface
Interface to the Steam unified messages client.

Deprecated - You should not need to use this interface.

Member Functions

Member functions for ISteamUnifiedMessages are called through the global accessor function SteamUnifiedMessages().

GetMethodResponseData

bool GetMethodResponseData( ClientUnifiedMessageHandle hHandle, void *pResponseBuffer, uint32 unResponseBufferSize, bool bAutoRelease );
NameTypeDescription
hHandleClientUnifiedMessageHandle
pResponseBuffervoid *
unResponseBufferSizeuint32
bAutoReleasebool

Gets a response in binary serialized form (and optionally release the corresponding allocated memory).

Returns: bool

GetMethodResponseInfo

bool GetMethodResponseInfo( ClientUnifiedMessageHandle hHandle, uint32 *punResponseSize, EResult *peResult );
NameTypeDescription
hHandleClientUnifiedMessageHandle
punResponseSizeuint32 *
peResultEResult *

Gets the size of the response and the EResult. Returns false if the response is not ready yet.

Returns: bool

ReleaseMethod

bool ReleaseMethod( ClientUnifiedMessageHandle hHandle );
NameTypeDescription
hHandleClientUnifiedMessageHandle

Releases the message and its corresponding allocated memory.

Returns: bool

SendMethod

ClientUnifiedMessageHandle SendMethod( const char *pchServiceMethod, const void *pRequestBuffer, uint32 unRequestBufferSize, uint64 unContext );
NameTypeDescription
pchServiceMethodconst char *
pRequestBufferconst void *
unRequestBufferSizeuint32
unContextuint64

Sends a service method (in binary serialized form) using the Steam Client.
Returns a unified message handle (k_InvalidUnifiedMessageHandle if could not send the message).

Returns: ClientUnifiedMessageHandle

SendNotification

bool SendNotification( const char *pchServiceNotification, const void *pNotificationBuffer, uint32 unNotificationBufferSize );
NameTypeDescription
pchServiceNotificationconst char *
pNotificationBufferconst void *
unNotificationBufferSizeuint32

Sends a service notification (in binary serialized form) using the Steam Client.
Returns true if the notification was sent successfully.

Returns: bool

Callbacks

These are callbacks which can be fired by calling SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of ISteamUnifiedMessages.

SteamUnifiedMessagesSendMethodResult_t



NameTypeDescription
m_hHandleClientUnifiedMessageHandleThe handle returned by SendMethod().
m_unContextuint64Context provided when calling SendMethod().
m_eResultEResultThe result of the method call.
m_unResponseSizeuint32The size of the response.

Typedefs

These are typedefs which are defined for use with ISteamUnifiedMessages.

NameBase typeDescription
ClientUnifiedMessageHandleuint64

Constants

These are constants which are defined for use with ISteamUnifiedMessages.

NameTypeValueDescription
STEAMUNIFIEDMESSAGES_INTERFACE_VERSIONconst char *"STEAMUNIFIEDMESSAGES_INTERFACE_VERSION001"