Platform SDK: DirectX |
The DPLMSG_SETPROPERTY message is sent by an application to the lobby to inform it that a property of a specific player or a property of the session has changed. These properties can range from the score or status of a player to the current level of a game or the current status of the session.
typedef struct { DWORD dwType; DWORD dwRequestID GUID guidPlayer; GUID guidPropertyTag; DWORD dwDataSize; DWORD dwPropertyData[1]; } DPLMSG_SETPROPERTY, FAR *LPDPLMSG_SETPROPERTY;
Each property is identified by a GUID (defined by the application developer or the lobby developer), and it is the responsibility of the lobby to maintain a mapping of property GUIDs of the various applications to their descriptions and data types. The lobby server can choose to act on the information or ignore it.
When constructing this message, the application needs to allocate enough memory to hold the DPLMSG_SETPROPERTY structure and the complete property data. For example, if the property data requires 52 bytes, the application will allocate (sizeof(DPLMSG_SETPROPERTY) + 52) bytes and assign it to a LPDPLMSG_SETPROPERTY pointer.
Windows NT/2000: Requires Windows 2000.
Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
Header: Declared in dplobby.h.