In This Topic ▼

GetString Method

Summary

Retrieves the specified key's associated value as a string.

Syntax

C++

public string GetString( 
   string key 
)

Public Function GetString( _ 
   ByVal key As String _ 
) As String

public: 
String^ GetString(  
   String^ key 
)

Parameters

key
string variable which contains the key of the value to retrieve.

Return Value

A string that represents the specified key's associated value.

Remarks

If the method fails, an error is raised. For more information, refer to the Error Codes.

Example

using Leadtools; 
using Leadtools.MediaStreaming; 
 
 
public Server _server = null; 
public bool _result = false; 
 
public void SetApplicationPropertiesExample() 
{ 
   try 
   { 
      // create an instance of the server object 
      _server = new Leadtools.MediaStreaming.Server(); 
 
      // retrieve a copy of the Application Properties object 
      ApplicationProperties Props = _server.GetApplicationProperties(); 
 
      // remove any existing values 
      Props.Clear(); 
 
      // set up various user-defined properties 
 
      Props.AddString("String", "test string"); 
 
      Props.AddInteger("Integer", 37); 
 
      Props.AddNumber("Number", 3.14); 
 
      Props.AddBoolean("Boolean", false); 
 
      Props.AddString("Path", "%ltmsRootFolder%\\dummy"); 
 
      // add a property and delete it 
      Props.AddString("Temp", "dummy"); 
      Props.Remove("Temp"); 
 
 
      // now print them out on a string for demonstration purposes 
      string strApplicationProperties = ""; 
 
      { 
         string str = Props.GetString("String"); 
         strApplicationProperties += string.Format("String = {0}\n", str); 
      } 
      { 
         int n = Props.GetInteger("Integer"); 
         strApplicationProperties += string.Format("Integer = {0}\n", n.ToString()); 
      } 
      { 
         double dbl = Props.GetNumber("Number"); 
         strApplicationProperties += string.Format("Number = {0}\n", dbl.ToString()); 
      } 
      { 
         bool boolean = Props.GetBoolean("Boolean"); 
         if (boolean) 
            strApplicationProperties += "Boolean = true\n"; 
         else 
            strApplicationProperties += "Boolean = false\n"; 
      } 
      { 
         string str = Props.GetResolvedPath("Path"); 
         strApplicationProperties += string.Format("Path = {0}\n", str); 
      } 
 
      // display a message contains the Application Properties string 
      MessageBox.Show(strApplicationProperties, "LEADTOOLS Media Streaming Examples", MessageBoxButtons.OK, MessageBoxIcon.Information); 
 
      // copy the Application Properties to the server 
      _server.SetApplicationProperties(Props); 
 
      _result = true; 
   } 
   catch (Exception) 
   { 
      _result = false; 
   } 
}

Imports Leadtools 
Imports Leadtools.MediaStreaming 
 
 
Public _server As Server = Nothing 
Public _result As Boolean = False 
 
Public Sub SetApplicationPropertiesExample() 
   Try 
      ' create an instance of the server object 
      _server = New Leadtools.MediaStreaming.Server() 
 
      ' retrieve a copy of the Application Properties object 
      Dim Props As ApplicationProperties = _server.GetApplicationProperties() 
 
      ' remove any existing values 
      Props.Clear() 
 
      ' set up various user-defined properties 
 
      Props.AddString("String", "test string") 
 
      Props.AddInteger("Integer", 37) 
 
      Props.AddNumber("Number", 3.14) 
 
      Props.AddBoolean("Boolean", False) 
 
      Props.AddString("Path", "%ltmsRootFolder%\dummy") 
 
      ' add a property and delete it 
      Props.AddString("Temp", "dummy") 
      Props.Remove("Temp") 
 
 
      ' now print them out on a string for demonstration purposes 
      Dim strApplicationProperties As String = "" 
 
      Dim str As String = Props.GetString("String") 
      strApplicationProperties &= String.Format("String = {0}" & Constants.vbLf, str) 
      Dim n As Integer = Props.GetInteger("Integer") 
      strApplicationProperties &= String.Format("Integer = {0}" & Constants.vbLf, n.ToString()) 
      Dim dbl As Double = Props.GetNumber("Number") 
      strApplicationProperties &= String.Format("Number = {0}" & Constants.vbLf, dbl.ToString()) 
      Dim [boolean] As Boolean = Props.GetBoolean("Boolean") 
      If [boolean] Then 
         strApplicationProperties &= "Boolean = true" & Constants.vbLf 
      Else 
         strApplicationProperties &= "Boolean = false" & Constants.vbLf 
      End If 
      Dim strResolvedPath As String = Props.GetResolvedPath("Path") 
      strApplicationProperties &= String.Format("Path = {0}" & Constants.vbLf, strResolvedPath) 
 
      ' display a message contains the Application Properties string 
      MessageBox.Show(strApplicationProperties, "LEADTOOLS Media Streaming Examples", MessageBoxButtons.OK, MessageBoxIcon.Information) 
 
      ' copy the Application Properties to the server 
      _server.SetApplicationProperties(Props) 
 
      _result = True 
   Catch e1 As Exception 
      _result = False 
   End Try 
End Sub

Requirements

Target Platforms

Reference

ApplicationProperties Class

ApplicationProperties Members

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.MediaStreaming Assembly

Introduction

Getting Started

Namespaces

Leadtools.MediaStreaming Namespace

Assemblies