Sc2RanksService.GetCharacterListBegin Method

Sc2RanksService GetCharacterListBegin 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 IAsyncResult GetCharacterListBegin(
	Object Key,
	IList<Sc2RanksCharacterSimple> Characters,
	AsyncCallback Callback,
	bool IgnoreCache = false
)

public IAsyncResult GetCharacterListBegin(
	Object Key,
	IList<Sc2RanksCharacterSimple> Characters,
	AsyncCallback Callback,
	bool IgnoreCache = false
)

Public Function GetCharacterListBegin ( 
	Key As Object,
	Characters As IList(Of Sc2RanksCharacterSimple),
	Callback As AsyncCallback,
	Optional IgnoreCache As Boolean = false
) As IAsyncResult

Public Function GetCharacterListBegin ( 
	Key As Object,
	Characters As IList(Of Sc2RanksCharacterSimple),
	Callback As AsyncCallback,
	Optional IgnoreCache As Boolean = false
) As IAsyncResult

public:
IAsyncResult^ GetCharacterListBegin(
	Object^ Key, 
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	AsyncCallback^ Callback, 
	bool IgnoreCache = false
)

public:
IAsyncResult^ GetCharacterListBegin(
	Object^ Key, 
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	AsyncCallback^ Callback, 
	bool IgnoreCache = false
)

Parameters

Key: Type: System Object
Can contain anything. Useful for tracking asynchronous calls. Is returned when the End method is called.

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

Callback: Type: System AsyncCallback
Address of a method to call when a result is available.

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

Return Value

Type:

IAsyncResult
Returns the status of the asynchronous operation.

Remarks