Sc2RanksService.CustomDivisionRemove Method

Sc2RanksService CustomDivisionRemove Method

NuGardt

Removes characters from the custom division, up to 200 at once. Returns the status of each ID passed, whether invalid, removed, not added or unknown.

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 CustomDivisionRemove(
	string DivisionID,
	IList<Sc2RanksCharacterSimple> Characters,
	out Sc2RanksCustomDivisionRemoveResult Result,
	bool IgnoreCache = false
)

public Exception CustomDivisionRemove(
	string DivisionID,
	IList<Sc2RanksCharacterSimple> Characters,
	out Sc2RanksCustomDivisionRemoveResult Result,
	bool IgnoreCache = false
)

Public Function CustomDivisionRemove ( 
	DivisionID As String,
	Characters As IList(Of Sc2RanksCharacterSimple),
	<OutAttribute> ByRef Result As Sc2RanksCustomDivisionRemoveResult,
	Optional IgnoreCache As Boolean = false
) As Exception

Public Function CustomDivisionRemove ( 
	DivisionID As String,
	Characters As IList(Of Sc2RanksCharacterSimple),
	<OutAttribute> ByRef Result As Sc2RanksCustomDivisionRemoveResult,
	Optional IgnoreCache As Boolean = false
) As Exception

public:
Exception^ CustomDivisionRemove(
	String^ DivisionID, 
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	[OutAttribute] Sc2RanksCustomDivisionRemoveResult^% Result, 
	bool IgnoreCache = false
)

public:
Exception^ CustomDivisionRemove(
	String^ DivisionID, 
	IList<Sc2RanksCharacterSimple^>^ Characters, 
	[OutAttribute] Sc2RanksCustomDivisionRemoveResult^% Result, 
	bool IgnoreCache = false
)

Parameters

DivisionID: Type: System String
The division identifier.

Characters: Type: System.Collections.Generic IList Sc2RanksCharacterSimple
A list of character information to remove.

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