EOS_ProgressionSnapshot_BeginSnapshot

EOS API reference page for EOS_ProgressionSnapshot_BeginSnapshot

Choose your implementation method:

C

C#

This function is part of the ProgressionSnapshot Interface.

Remarks

Creates a new progression-snapshot resource for a given user.

Return Value

  • EOS_Success when successful.

  • EOS_ProgressionSnapshot_SnapshotIdUnavailable when no IDs are available. This is irrecoverable state.

Parameters

EOS_ProgressionSnapshot_BeginSnapshot

Parameter Type And Name

Usage Information

EOS_HProgressionSnapshot Handle

const EOS_ProgressionSnapshot_BeginSnapshotOptions* Options

Object containing properties that identifies the PUID this Snapshot will belong to.

uint32_t* OutSnapshotId

A progression-snapshot identifier output parameter. Use that identifier to reference the snapshot in the other APIs.

Related API Members

This function is part of the ProgressionSnapshot Interface.

Remarks

Creates a new progression-snapshot resource for a given user. {Result.ProgressionSnapshotSnapshotIdUnavailable} when no IDs are available. This is irrecoverable state.

Return Value

{Result.Success} when successful.

Parameters

ProgressionSnapshot.ProgressionSnapshotInterface.BeginSnapshot

Parameter Type And Name

Usage Information

BeginSnapshotOptions options

Object containing properties that identifies the PUID this Snapshot will belong to.

uint outSnapshotId

A progression-snapshot identifier output parameter. Use that identifier to reference the snapshot in the other APIs.

Related API Members