EOS_Sanctions_CopyPlayerSanctionByIndex

EOS API reference page for EOS_Sanctions_CopyPlayerSanctionByIndex

Choose your implementation method:

C

C#

This function is part of the Sanctions Interface.

Remarks

Copies an active player sanction. You must call QueryActivePlayerSanctions first to retrieve the data from the service backend. On success, EOS_Sanctions_PlayerSanction_Release must be called on OutSanction to free memory.

Return Value

  • EOS_Success if the information is available and passed out in OutSanction

  • EOS_InvalidParameters if you pass a null pointer for the out parameter

  • EOS_NotFound if the player achievement is not found

See Also

EOS_Sanctions_QueryActivePlayerSanctions, EOS_Sanctions_PlayerSanction_Release

Parameters

EOS_Sanctions_CopyPlayerSanctionByIndex

Parameter Type And Name

Usage Information

EOS_HSanctions Handle

const EOS_Sanctions_CopyPlayerSanctionByIndexOptions* Options

Structure containing the input parameters

EOS_Sanctions_PlayerSanction** OutSanction

The player sanction data for the given index, if it exists and is valid

If successful, this function provides data to the caller through an output parameter. Once you are finished with the data, you must release it by making the appropriate call into the EOS SDK.

Related API Members

This function is part of the Sanctions Interface.

Remarks

Copies an active player sanction. You must call QueryActivePlayerSanctions first to retrieve the data from the service backend. On success, {Release} must be called on OutSanction to free memory. {Result.InvalidParameters} if you pass a null pointer for the out parameter {Result.NotFound} if the player achievement is not found

Return Value

{Result.Success} if the information is available and passed out in OutSanction

See Also

{QueryActivePlayerSanctions}, {Release}

Parameters

Sanctions.SanctionsInterface.CopyPlayerSanctionByIndex

Parameter Type And Name

Usage Information

CopyPlayerSanctionByIndexOptions options

Structure containing the input parameters

PlayerSanction outSanction

The player sanction data for the given index, if it exists and is valid

If successful, this function provides data to the caller through an output parameter. The EOS SDK will automatically handle releasing the data when your code no longer holds any reference to it; you do not need to call a "Release" function.

Related API Members

Tags