Sc2RanksService.GetCharacter Method

Sc2RanksService GetCharacter Method

NuGardt

Returns a single character.

Namespace: NuGardt.SC2Ranks.API
Assembly: NuGardt.SC2Ranks.API (in NuGardt.SC2Ranks.API.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

C++

Copy to Clipboard Print

public Exception GetCharacter(
	eSc2RanksRegion Region,
	int BattleNetID,
	out Sc2RanksGetCharacterResult Result,
	bool IgnoreCache = false
)

public Exception GetCharacter(
	eSc2RanksRegion Region,
	int BattleNetID,
	out Sc2RanksGetCharacterResult Result,
	bool IgnoreCache = false
)

Public Function GetCharacter ( 
	Region As eSc2RanksRegion,
	BattleNetID As Integer,
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterResult,
	Optional IgnoreCache As Boolean = false
) As Exception

Public Function GetCharacter ( 
	Region As eSc2RanksRegion,
	BattleNetID As Integer,
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterResult,
	Optional IgnoreCache As Boolean = false
) As Exception

public:
Exception^ GetCharacter(
	eSc2RanksRegion Region, 
	int BattleNetID, 
	[OutAttribute] Sc2RanksGetCharacterResult^% Result, 
	bool IgnoreCache = false
)

public:
Exception^ GetCharacter(
	eSc2RanksRegion Region, 
	int BattleNetID, 
	[OutAttribute] Sc2RanksGetCharacterResult^% Result, 
	bool IgnoreCache = false
)

Parameters

Region: Type: NuGardt.SC2Ranks.API eSc2RanksRegion
The region of the character.

BattleNetID: Type: System Int32
The Battle.net identifier.

Result: Type: NuGardt.SC2Ranks.API.Result Sc2RanksGetCharacterResult
Contains the result. Is Nothing if no data was received and the query timed out.

IgnoreCache (Optional): Type: System Boolean
Optional. Default is False. Ignores any cached data that might be available when caching is enabled.

Return Value

Type:

Exception
Return an System.Exception if an error occurred otherwise Nothing.

Remarks