IFsrmQuotaManager::EnumQuotas method

[This method is supported for compatibility but it's recommended to use the FSRM WMI Classes to manage FSRM. Please see the MSFT_FSRMQuota class.]

Enumerates the quotas for the specified directory and any quotas associated with its subdirectories (recursively).

Syntax


HRESULT EnumQuotas(
  [in]   BSTR path,
  [in]   FsrmEnumOptions options,
  [out]  IFsrmCommittableCollection **quotas
);

Parameters

path [in]

The local directory path that is associated with the quota that you want to enumerate. The string is limited to 260 characters.

If the path ends with "\*", retrieve all quotas associated with the immediate subdirectories of the path (does not include the quota associated with the path).

If the path ends with "\...", retrieve the quota for the path and all quotas associated with the immediate subdirectories of the path (recursively).

If the path does not end in "\*" or "\...", retrieve the quota for the path only.

If path is null or empty, the method returns all quotas.

options [in]

Options to use when enumerating the quotas. For possible values, see the FsrmEnumOptions enumeration.

quotas [out]

An IFsrmCommittableCollection interface that contains a collection of the quotas.

Each item of the collection is a VARIANT of type VT_DISPATCH. Query the pdispVal member of the variant for the IFsrmQuota interface.

The collection is empty if the path does not contain quotas.

Return value

The method returns the following return values.

Return codeDescription
S_OK

Success

E_INVALIDARG

Returns this code for the following reasons:

  • The options parameter contains FsrmEnumOptions_Asynchronous; the asynchronous option is not supported.
  • The quotas parameter is NULL.

 

Remarks

To enumerate quotas that apply automatically to the path's subdirectories, call the IFsrmQuotaManager::EnumAutoApplyQuotas method.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Header

FsrmQuota.h (include FsrmQuota.h or FsrmTlb.h)

DLL

SrmSvc.dll

CLSID

CLSID_FsrmQuotaManager is defined as 90dcab7f-347c-4bfc-b543-540326305fbe

IID

IID_IFsrmQuotaManager is defined as 8bb68c7d-19d8-4ffb-809e-be4fc1734014

IID_IFsrmQuotaManagerEx is defined as 4846cb01-d430-494f-abb4-b1054999fb09

See also

IFsrmQuotaManager
IFsrmQuotaManagerEx
FsrmQuotaManager
MSFT_FSRMQuota

 

 

Show:
© 2014 Microsoft