##

IDirectPlay3::SetGroupName

IDirectPlay3 Interface

Sets the name of a group after it has been created. Only the computer that created the group can set the name of the group. 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 SetGroupName(
DPID idGroup,
LPDPNAME lpGroupName,
DWORD dwFlags
);

##### Parameters

idGroup
  ID of the group for which the name is being set.
lpGroupName
  Pointer to a DPNAME structure containing the name information for the group. Set this parameter to NULL if the group has no name information.
dwFlags
  If this parameter is set to 0, the name will be propagated to all the remote systems by using nonguaranteed message passing. This value can only be used on groups owned by the local session.
  DPSET_GUARANTEED
    Propagates the data using guaranteed messaging (if available).
  DPSET_LOCAL
    This data is for local use only and will not be propagated.
  DPSET_REMOTE
    This data is for use by all the applications, and will be propagated to all the other applications in the session. This flag can only be used on groups owned by the local session.

##### Return Values

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

DPERR_INVALIDGROUP
DPERR_INVALIDOBJECT
DPERR_INVALIDPARAMS
DPERR_INVALIDPLAYER

##### See Also

DPNAME, DPMSG_SETPLAYERORGROUPNAME, IDirectPlay3::GetGroupName, IDirectPlay3::Send

© 1997 Microsoft Corporation. All rights reserved. Terms of Use.