SiteConfig.GetSQLScript Method (PIA)

  • Article

Use this method to get the specified SQL script file from the Administration database.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Configuration
…
Public Function GetSQLScript(sResource As String,
  sScriptName As String) As String

[C#]

using Microsoft.CommerceServer.Interop.Configuration;
…
public string GetSQLScript(stringsResource,
  stringsScriptName);

Parameters

[Visual Basic .NET]

  • sResource
    A String that contains the resource associated with the required SQL script file.
  • sScriptName
    A String that contains the file name of the required SQL script file.

[C#]

  • sResource
    A string that contains the resource associated with the required SQL script file.
  • sScriptName
    A string that contains the file name of the required SQL script file.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a String that contains the SQL script file contents.

[C#] A string containing the SQL script file contents.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

The Initialize method must be called before this method can be used.

[Visual Basic .NET]

Example

' sMyCatalog is an existing resource
' sMySQLFileName.sql and sContents are strings
' oSiteConfig is a Commerce SiteConfig object
sContents = oSiteConfig.GetSQLScript(sMyCatalog, sMySQLFileName.sql)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Configuration

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_mscscfg (in cs_mscscfg.dll)

See Also

SiteConfig Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.