[This is preliminary documentation and is subject to change.]
Searches subtitles by title.
Namespace:
Subtitles.ServicesAssembly: Subtitles.Services (in Subtitles.Services)
Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# |
|---|
bool ManualSearch( Guid session, string title, Nullable<byte> season, Nullable<int> episode, SubtitleLanguage[] languages, Genre[] genres, out Subtitle[] subtitles, out SubtitleActions[] actions, out string error ) |
| Visual Basic (Declaration) |
|---|
Function ManualSearch ( _ session As Guid, _ title As String, _ season As Nullable(Of Byte), _ episode As Nullable(Of Integer), _ 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 ManualSearch( Guid session, String^ title, Nullable<unsigned char> season, Nullable<int> episode, 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.
- title
- Type: System..::.String
Title.
- season
- Type: System..::.Nullable<(Of <(Byte>)>)
Optional filter: season number.
- episode
- Type: System..::.Nullable<(Of <(Int32>)>)
Optional filter: episode number.
- languages
- Type: array<Subtitles.Services.Types..::.SubtitleLanguage>[]()[]
Filter: array of languages we want to include in search.
- genres
- Type: array<Subtitles.Services.Types..::.Genre>[]()[]
Filter: array of genres we want to include in search.
- 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.