XblSocialRelationshipResultGetRelationships
Get a list of the XblSocialRelationship objects from an XblSocialRelationshipResultHandle.
Syntax
HRESULT XblSocialRelationshipResultGetRelationships(
XblSocialRelationshipResultHandle resultHandle,
const XblSocialRelationship** relationships,
size_t* relationshipsCount
)
Parameters
resultHandle _In_
Type: XblSocialRelationshipResultHandle
Social relationship result handle.
relationships _Out_
Type: XblSocialRelationship**
Passes back a pointer to an array of XblSocialRelationship objects. The memory for the returned pointer remains valid for the life of the XblSocialRelationshipResultHandle object until it is closed.
relationshipsCount _Out_
Type: size_t*
Passes back the number of items in the relationships array.
Return value
Type: HRESULT
HRESULT return code for this API operation.
Remarks
When no longer using the XblSocialRelationshipResultHandle, make sure to call XblSocialRelationshipResultCloseHandle. When all outstanding handles have been closed, the memory associated with the social relationship's results list will be freed.
Requirements
Header: social_c.h
Library: Microsoft.Xbox.Services.141.GSDK.C.lib