IDirectPlay4::SetPlayerName

The IDirectPlay4::SetPlayerName method sets the name of a local player after it has been changed. Only the computer that created the player can change the name. A DPMSG_SETPLAYERORGROUPNAME system message will be sent to all the other players notifying them of the change unless DPSESSION_NODATAMESSAGES is set in the session description.

HRESULT SetPlayerName(
  DPID idPlayer,
  LPDPNAME lpPlayerName,
  DWORD dwFlags
);

Parameters

idPlayer

ID of the local player for which data is being sent.

lpPlayerName

Pointer to a DPNAME structure containing the name information for the player. Set this parameter to NULL if the player has no name information.

dwFlags

Flags indicating how the name will be propagated. It can be one of the following values:

DPSET_GUARANTEED

Propagates the data by using guaranteed messaging (if available).

DPSET_LOCAL

Data is not propagated to other players.

DPSET_REMOTE

Propagates the data to all players in the session using nonguaranteed message passing. This is the default value.

Return Values

Returns DP_OK if successful, or one of the following error values otherwise:

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dplay.h.
  Import Library: Use dplayx.lib.

See Also

DPNAME, DPMSG_SETPLAYERORGROUPNAME, IDirectPlay4::GetPlayerName, IDirectPlay4::Send