XblLocalStorageWriteHandler

Invoked by XSAPI to request the client to perform a local storage write operation.

Syntax

void XblLocalStorageWriteHandler(  
         void* context,  
         XblClientOperationHandle operation,  
         XblUserHandle user,  
         XblLocalStorageWriteMode mode,  
         char key,  
         size_t dataSize,  
         void data  
)  

Parameters

context   _In_opt_
Type: void*

Optional pointer to data used by the event handler.

operation   _In_
Type: XblClientOperationHandle

The handle for this operation.

user   _In_
Type: XblUserHandle

The user for which the data is being written.

mode   _In_
Type: XblLocalStorageWriteMode

The mode to be used for the write operation.

key   _In_z_
Type: char

Identifies the data being written.

dataSize   _In_
Type: size_t

The size (in bytes) of the data.

data   _In_reads_bytes_(dataSize)
Type: void

The data to write.

Return value

Type: void

Remarks

When the operation is complete, XblLocalStorageWriteComplete should be called. Apart from context, all parameters are owned by XSAPI and are guaranteed to be valid until the operation is complete.

Requirements

Header: platform_c.h

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

See also

platform_c