GenerateSQL Method (Table, UserDefinedDatatype) (SQL-DMO)

The GenerateSQL method returns a string containing a Transact-SQL command batch that can be used to create the the Microsoft® SQL Server™ database object defined by the properties of the SQL-DMO object used.

Applies To

Table Object

UserDefinedDatatype Object

Syntax

object.GenerateSQL( Database ) as String

Part	Description
object	Expression that evaluates to an object in the Applies To list
Database	Expression that evaluates to a SQL-DMO Database object

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.

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 by using SysFreeString.