[This is preliminary documentation and is subject to change.]

Searches subtitles by release name.

Namespace:  Subtitles.Services
Assembly:  Subtitles.Services (in Subtitles.Services)
Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
bool SearchByRelease(
	Guid session,
	string releaseName,
	SubtitleLanguage[] languages,
	Genre[] genres,
	out Subtitle[] subtitles,
	out SubtitleActions[] actions,
	out string error
)
Visual Basic (Declaration)
Function SearchByRelease ( _
	session As Guid, _
	releaseName As String, _
	languages As SubtitleLanguage(), _
	genres As Genre(), _
	<OutAttribute> ByRef subtitles As Subtitle(), _
	<OutAttribute> ByRef actions As SubtitleActions(), _
	<OutAttribute> ByRef error As String _
) As Boolean
Visual C++
bool SearchByRelease(
	Guid session, 
	String^ releaseName, 
	array<SubtitleLanguage>^ languages, 
	array<Genre>^ genres, 
	[OutAttribute] array<Subtitle>^% subtitles, 
	[OutAttribute] array<SubtitleActions^>^% actions, 
	[OutAttribute] String^% error
)

Parameters

session
Type: System..::.Guid
Unique session identifier obtained by ISession..::.LogIn(String, String, String, String%) method.
releaseName
Type: System..::.String
Release name (video file name without extension).
languages
Type: array<Subtitles.Services.Types..::.SubtitleLanguage>[]()[]
Optional language filter. If parameter is null then language filter is not applied.
genres
Type: array<Subtitles.Services.Types..::.Genre>[]()[]
Optional genre filter. If parameter is null then genre filter is not applied.
subtitles
Type: array<Subtitles.Services.Types..::.Subtitle>[]()[]%
Array of subtitles which match search criteria.
actions
Type: array<Subtitles.Services.Types..::.SubtitleActions>[]()[]%
Allowed actions for each subtitle.
error
Type: System..::.String%
Error description.

Return Value

True on success, false otherwise.

See Also