_SiteConfig::GetSQLScript Method [C++]

Article
11/12/2009

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

Definition

[C++]

HRESULT _SiteConfig::GetSQLScript(BSTRsResource,
  BSTRsScriptName,
  BSTR*strScriptContents);

[Visual Basic]

Function GetSQLScript(sResource As String,
  sScriptName As String) As String

Parameters

sResource[C++]
[in] A BSTR that contains the resource associated with the required SQL script file.
sResource[Visual Basic]
A String that contains the resource associated with the required SQL script file.
sScriptName[C++]
[in] A BSTR that contains the file name of the required SQL script file.
sScriptName[Visual Basic]
A String that contains the file name of the required SQL script file.
strScriptContents[C++]
[out, retval] A pointer to a BSTR used to return the SQL script file contents.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

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

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

All ADO, SQL, and ODBC errors will also be returned by this method.

Remarks

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

[C++] The strScriptContents parameter points to valid data only if the method completes successfully.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.