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

Reads user setting.

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

Syntax

C#
bool GetUserSetting(
	Guid session,
	string key,
	out string value
)
Visual Basic (Declaration)
Function GetUserSetting ( _
	session As Guid, _
	key As String, _
	<OutAttribute> ByRef value As String _
) As Boolean
Visual C++
bool GetUserSetting(
	Guid session, 
	String^ key, 
	[OutAttribute] String^% value
)

Parameters

session
Type: System..::.Guid
Unique session identifier obtained by ISession..::.LogIn(String, String, String, String%) method.
key
Type: System..::.String
Key name.
value
Type: System..::.String%
Value for given key. If there is no value null is returned.

Return Value

True on success, false otherwise.

See Also