IFhScopeIterator::GetItem method (fhcfg.h)

Article
02/22/2024

Retrieves the current item in an inclusion or exclusion list.

Note

IFhScopeIterator is deprecated and may be altered or unavailable in future releases.

Syntax

HRESULT GetItem(
  [out] BSTR *Item
);

Parameters

[out] Item

This parameter must be NULL on input. On output, it receives a pointer to a string that contains the current element of the list. This element is a library name or a folder name, depending on the parameters that were passed to the IFhConfigMgr::GetIncludeExcludeRules method. The string is allocated by calling SysAllocString. You must call SysFreeString to free the string when it is no longer needed.

Return value

S_OK on success, or an unsuccessful HRESULT on failure. Possible unsuccessful HRESULT values include values defined in the FhErrors.h header file.

Remarks

To move to the next item in the inclusion or exclusion list, call the IFhScopeIterator::MoveToNextItem method.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	fhcfg.h