GenerateCreationSQLOnView Method

SQL-DMO

SQL-DMO

GenerateCreationSQLOnView Method

The GenerateCreationSQLOnView method returns a string that contains a Transact-SQL command batch. This command batch can be used to create the Microsoft® SQL Server™ 2000 index defined by the properties of the Index object used to create the index.

Applies To
Index2 Object
Syntax

object.GenerateCreationSQLOnView( TargetView ) as String

Parts

object

Expression that evaluates to an object in the Applies To list

TargetView

Expression that evaluates to a View object in SQL-DMO

Prototype (C/C++)

HRESULT GenerateCreationSQLOnView(
LPSQLDMOVIEW TargetView,
SQLDMO_LPBSTR pSQLStatement);

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.

Remarks

The Index2 object exposes the GenerateSQLOnView and GenerateCreationSQLOnView methods. Both methods generate a command batch when creating an index. However, the Transact-SQL command batch returned by the GenerateCreationSQLOnView method prefixes an index creation statement with a statement that conditionally removes the index.

See Also

GenerateSQLOnView Method