GenerateCreationSQL Method (SQL-DMO)

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

Applies To

Index Object

Syntax

object.GenerateCreationSQL( Table ) as String

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

Returns

A Transact-SQL command batch as a string.

Remarks

The Index object exposes the GenerateSQL and GenerateCreationSQL methods. Both methods generate a command batch creating an index. However, the Transact-SQL command batch returned by the GenerateCreationSQL method prefixes an index creation statement with a statement conditionally dropping the index.

For more information about using the GenerateSQL and GenerateCreationSQL methods, see GenerateSQL Method (Index).

Prototype (C/C++)

HRESULT GenerateCreationSQL(
LPSQLDMOTABLE TargetTable,
SQLDMO_LPBSTR Messages);


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.


  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.