Share via

  • Article

SqlSmoObject.GetStringParameter Method (StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)

Assigns a string parameter of the SqlSmoObject object.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Protected Friend Function GetStringParameter ( _
    buffer As StringBuilder, _
    so As ScriptingOptions, _
    propName As String, _
    sqlPropScript As String, _
    ByRef count As Integer, _
    throwIfNotSet As Boolean _
) As Boolean
'Usage
Dim buffer As StringBuilder
Dim so As ScriptingOptions
Dim propName As String
Dim sqlPropScript As String
Dim count As Integer
Dim throwIfNotSet As Boolean
Dim returnValue As Boolean

returnValue = Me.GetStringParameter(buffer, _
    so, propName, sqlPropScript, count, _
    throwIfNotSet)

protected internal bool GetStringParameter(
    StringBuilder buffer,
    ScriptingOptions so,
    string propName,
    string sqlPropScript,
    ref int count,
    bool throwIfNotSet
)

protected public:
bool GetStringParameter(
    StringBuilder^ buffer, 
    ScriptingOptions^ so, 
    String^ propName, 
    String^ sqlPropScript, 
    int% count, 
    bool throwIfNotSet
)

member GetStringParameter : 
        buffer:StringBuilder * 
        so:ScriptingOptions * 
        propName:string * 
        sqlPropScript:string * 
        count:int byref * 
        throwIfNotSet:bool -> bool 

 function GetStringParameter(
    buffer : StringBuilder, 
    so : ScriptingOptions, 
    propName : String, 
    sqlPropScript : String, 
    count : int, 
    throwIfNotSet : boolean
) : boolean

Parameters

  • propName
    Type: System.String
    A string value that specifies the property name.
  • sqlPropScript
    Type: System.String
    A string value that specifies the script.
  • throwIfNotSet
    Type: System.Boolean
    A Boolean value that indicates whether to throw and exception if the parameter is not set.

Return Value

Type: System.Boolean
A Boolean value, true if the method succeeds, otherwise false.