XblMultiplayerActivityGetActivityResult

Gets the results for a successful get activity call.

Syntax

HRESULT XblMultiplayerActivityGetActivityResult(  
         XAsyncBlock* async,  
         size_t bufferSize,  
         void* buffer,  
         XblMultiplayerActivityInfo** ptrToBufferResults,  
         size_t* resultCount,  
         size_t* bufferUsed  
)  

Parameters

async   _In_
Type: XAsyncBlock*

The XAsyncBlock for this operation.

bufferSize   _In_
Type: size_t

The size of the result buffer. Use XblMultiplayerActivityGetActivityResultSize to get the required buffer size.

buffer   _Out_writes_bytes_to_(bufferSize,bufferUsed)
Type: void

A caller-allocated byte buffer that receives the result.

ptrToBufferResults   _Outptr_
Type: XblMultiplayerActivityInfo**

Strongly typed array of XblMultiplayerActivityInfo that points into buffer. Do not free this array. Its lifecycle is tied to buffer.

resultCount   _Out_
Type: size_t*

The number of entries in the ptrToBufferResults array.

bufferUsed   _Out_opt_
Type: size_t*

The number of bytes in buffer that were used.

Return value

Type: HRESULT

HRESULT return code for this API operation.

Remarks

To get the size of the buffer that you need to store the results, call the XblMultiplayerActivityGetActivityResultSize function.

To see how this function is used, see "Getting activities" in the Activities section of Example code for Multiplayer Activity.

For more information about multiplayer activities, see Activities.

Requirements

Header: multiplayer_activity_c.h

Library: Microsoft.Xbox.Services.141.GSDK.C.lib

See also

multiplayer_activity_c