IFhTarget::GetNumericalProperty method (fhcfg.h)

Article
02/22/2024

Retrieves a numeric property of the File History backup target that is represented by an IFhTarget interface.

Note

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

Syntax

HRESULT GetNumericalProperty(
  [in]  FH_TARGET_PROPERTY_TYPE PropertyType,
  [out] ULONGLONG               *PropertyValue
);

Parameters

[in] PropertyType

Specifies the numeric property. See the FH_TARGET_PROPERTY_TYPE enumeration for a list of possible numeric properties.

[out] PropertyValue

Receives the value of the numeric property.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code such as one of the values defined in the FhErrors.h header file.

Remarks

The FH_TARGET_PROPERTY_TYPE enumeration defines property types for string properties and numeric properties. However, the IFhTarget::GetNumericalProperty method can only be used to retrieve numeric properties. String properties must be retrieved by calling the IFhTarget::GetStringProperty 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