EnumFileGroups Method

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 EnumFileGroups method returns a QueryResults object that enumerates the filegroups of a Microsoft SQL Server database.

Syntax

object
.EnumFileGroups( )
as 
QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

Prototype (C/C++)

HRESULT EnumFileGroups(
LPSQLDMOQUERYRESULTS* ppResults);

Returns

A QueryResults object that contains one result set defined by these columns.

Column

Data type

Description

groupid

smallint

System-generated filegroup identifier.

allocpolicy

smallint

Reserved for future use.

status

integer

Interpret as specified in Remarks.

groupname

nvarchar(129)

Name of the filegroup.

Remarks

Interpret the value of the status column using these values.

Value

Description

0

User-defined filegroup.

8

Filegroup defined on files maintained on read-only media.

16

Primary filegroup.

Applies To: