DirectPlay4.GetGroupData

The DirectPlay4.GetGroupData method retrieves an application-specific string associated with a group.

object.GetGroupData(GroupId As Long, _
    flags As CONST_DPGETFLAGS) As String 

Parameters

object

Object expression that resolves to a DirectPlay4 object.

GroupId

Group ID for which data is being requested.

flags

Value from the CONST_DPGETFLAGS enumeration indicating the type of group data to retrieve: local or remote. If this parameter is set to 0, remote data will be retrieved.

Return Values

If it succeeds, the method returns a string containing the data associated with the group by using the DirectPlay4.SetGroupData method.

Error Codes

If the method fails, an error is raised and Err.Number may be set to one of the following values:

Remarks

DirectPlay can maintain two types of group data: local and remote. The application must specify which type of data to retrieve. Local data was set by this DirectPlay object by using the DPSET_LOCAL flag. Remote data might have been set by any application in the session by using the DPSET_REMOTE flag.