GenerateSQL Method (Table, UserDefinedDatatype)
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The GenerateSQL method returns a string that contains a Transact-SQL command batch used to create the Microsoft SQL Server database object defined by the properties of the SQL Distributed Management Objects (SQL-DMO) object used.
Syntax
object
.GenerateSQL(
Database
)
as
String
Parts
- object
Expression that evaluates to an object in the Applies To list.
- Database
Expression that evaluates to a SQL-DMO Database object.
Prototype (C/C++)
HRESULT GenerateSQL(
LPSQLDMODATABASE pDB,
SQLDMO_LPBSTR pRetVal);
Note
SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.
Returns
A Transact-SQL command batch as a string.
Remarks
The GenerateSQL method generates a Transact-SQL batch that creates a database object. The method fails if the SQL-DMO object used references an existing SQL Server database object. Use the Script method of the Table or UserDefinedDatatype objects to create a Transact-SQL command batch defining an existing table or user-defined data type.