Functions for sending and receiving messages from the Game Coordinator.

This is largely deprecated, and only continues to exist for the couple games that still use this.

Functions

NOTE: ISteamGameCoordinator does not expose a global accessor function. You must access it through ISteamClient::GetISteamGenericInterface.

IsMessageAvailable

Name	Type	Description
pcubMsgSize	uint32 *	Returns the size of the message in bytes.

Checks if there is a message waiting from the game coordinator.

Returns: bool
true if a message is available; otherwise, false.

RetrieveMessage

Name	Type	Description
punMsgType	uint32 *
pubDest	void *
cubDest	uint32
pcubMsgSize	uint32 *

Fills the provided buffer with the first message in the queue and returns k_EGCResultOK or returns k_EGCResultNoMessage if there is no message waiting. pcubMsgSize is filled with the message size.

If the provided buffer is not large enough to fit the entire message, k_EGCResultBufferTooSmall is returned and the message remains at the head of the queue.

Returns: EGCResults

SendMessage

Name	Type	Description
unMsgType	uint32
pubData	const void *
cubData	uint32

Sends a message to the Game Coordinator.

Returns: EGCResults

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 ISteamGameCoordinator.

GCMessageAvailable_t

callbacks
callback notification - A new message is available for reading from the message queue

Name	Type	Description
m_nMessageSize	uint32

GCMessageFailed_t

callback notification - A message failed to make it to the GC. It may be down temporarily

This callback has no fields.

Enums

These are enums which are defined for use with ISteamGameCoordinator.

EGCResults

List of possible return values from the ISteamGameCoordinator API.

Name	Value	Description
k_EGCResultOK	0	Success.
k_EGCResultNoMessage	1	There is no message in the queue.
k_EGCResultBufferTooSmall	2	The buffer is too small for the requested message.
k_EGCResultNotLoggedOn	3	The client is not logged onto Steam.
k_EGCResultInvalidMessage	4	Something was wrong with the message being sent with SendMessage.

Constants

These are constants which are defined for use with ISteamGameCoordinator.

Name	Type	Value	Description
STEAMGAMECOORDINATOR_INTERFACE_VERSION	const char *	"SteamGameCoordinator001"