Welcome to
www.tdxlibrary.org
Home of the
the TDx_Library...
"RAD DirectX"
for
C++ Builder
...
- Description
The OnGetProperty event is triggered when using the TDx_PlayLobby::ReceiveLobbyMessageEx() method in the TDx_PlayLobby::OnReceive() event.
This event indicates that DPLSYS_GETPROPERTY has been received by the component's event thread.
DPLSYS_GETPROPERTY is sent when an application requests property values from the lobby.
- Parameters
Player
The Player parameter is used to identify the player that the data is relevent for. If the data required is not player specific, then set this parameter to GUID_NULL. The GUID of the player can be obtained by requesting the DPLPROPERTY_PlayerGuid property in a TDPLMSG_GetProperty structure as the data parameter of a PlayLobby::SendLobbyMessage() call.
PropertyTag
The PropertyTag parameter is used to identify the required property. Applicactions can define their own properties by supplying a unique GUID as the PropertyTag value in a SetProperty structure, and passing the structure as the data parameter of a PlayLobby::SendLobbyMessage() call.
Predefined Microsoft GUIDs include
DPLPROPERTY_LobbyGuid
If a specific lobby is required by the client, this value can be used to identify the lobby software.
A GUID used to identify the lobby software. If an application was designed to interoperate with a specific lobby using custom messages, this property can be used to identify the lobby.
However, an application should attempt to use standard messages whenever possible to be able to interoperate with as many lobbies as possible.
For this property, the dwPropertyData field of the DPLMSG_GETPROPERTYRESPONSE structure will contain the following:
GUID guidLobby;
RequestID
The RequestIDis an application defined value used to identify requests. The lobby will reply with a GetPropertyResponse system message that will trigger an ONDPLMSGGetPropertyResponse event in the application. The RequestID parameter will be this value.
Sender
The Sender parameter refers to the object that signalled the event.
- See Also
- Top
TDx_Play_Library v2.00 Component Reference
|
|
|
[ TDx_PlayLobby::OnGetProperty() ] [ next: OnGetPropertyResponse() ] [ prev: OnGeneric() ] __published:
__property TDx_OnGetProperty OnGetProperty = {read=FOnGetProperty, write=FOnGetProperty, nodefault};
TDX_PLAYLOBBY::ONGETPROPERTY()
[ component event ]
If you would like to submit additions or improvements to this page, click: darren_john_dwyer@hotmail.com. |
|