Sc2RanksService.GetCharacterList Method

Sc2RanksService GetCharacterList Method

NuGardt

Accepts an array of characters with region and bnet_id, up to 200 characters at once. If one of the passed characters is invalid (region/bnet id/not found) then the bnet_id/region are returned with the error.

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 GetCharacterList(
	IList<Sc2RanksCharacterSimple> Characters,
	out Sc2RanksGetCharacterListResult Result,
	bool IgnoreCache = false
)

public Exception GetCharacterList(
	IList<Sc2RanksCharacterSimple> Characters,
	out Sc2RanksGetCharacterListResult Result,
	bool IgnoreCache = false
)

Public Function GetCharacterList ( 
	Characters As IList(Of Sc2RanksCharacterSimple),
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterListResult,
	Optional IgnoreCache As Boolean = false
) As Exception

Public Function GetCharacterList ( 
	Characters As IList(Of Sc2RanksCharacterSimple),
	<OutAttribute> ByRef Result As Sc2RanksGetCharacterListResult,
	Optional IgnoreCache As Boolean = false
) As Exception

public:
Exception^ GetCharacterList(
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	[OutAttribute] Sc2RanksGetCharacterListResult^% Result, 
	bool IgnoreCache = false
)

public:
Exception^ GetCharacterList(
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	[OutAttribute] Sc2RanksGetCharacterListResult^% Result, 
	bool IgnoreCache = false
)

Parameters

Characters: Type: System.Collections.Generic IList Sc2RanksCharacterSimple
A list of character information to get more information on.

Result: Type: NuGardt.SC2Ranks.API.Result Sc2RanksGetCharacterListResult
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