IDirectPlay4::GetGroupName
IDirectPlay4 Interface
Returns the name associated with a group.
Syntax
HRESULT GetGroupName(
DPID idGroup,
LPVOID lpData,
LPDWORD lpdwDataSize
);
Parameters
- idGroup
- ID of the group whose name is being requested.
- lpData
- Pointer to a buffer where the name data is to be written. Set this parameter to NULL to request only the size of data. lpdwDataSize will be set to the size required to hold the data.
- lpdwDataSize
- Pointer to a variable that is initialized to the size of the buffer before calling the method. After the method returns, this parameter will be set to the size, in bytes, of the name data. If the buffer was too small (DPERR_BUFFERTOOSMALL), then this parameter will be set to the buffer size that is required.
Return Value
Returns DP_OK if successful, or one of the following error values otherwise:
DPERR_BUFFERTOOSMALL DPERR_INVALIDGROUP DPERR_INVALIDOBJECT DPERR_INVALIDPARAMS DPERR_INVALIDPLAYER
Remarks
After the method returns, the pointer lpData should be cast to the DPNAME structure to read the group name data.
See Also
Top of Page
© 1998 Microsoft Corporation. All rights reserved. Terms of Use.