IFhTarget::GetStringProperty method (fhcfg.h)

Article
02/22/2024

Retrieves a string 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 GetStringProperty(
  [in]  FH_TARGET_PROPERTY_TYPE PropertyType,
  [out] BSTR                    *PropertyValue
);

Parameters

[in] PropertyType

Specifies the string property. See the FH_TARGET_PROPERTY_TYPE enumeration for the list of possible string property types.

[out] PropertyValue

This parameter must be NULL on input. On output, it receives a pointer to a string that contains the string property. This string is allocated by calling SysAllocString. You must call SysFreeString to free the string when it is no longer needed.

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::GetStringProperty method can only be used to retrieve string properties. Numeric properties must be retrieved by calling the IFhTarget::GetNumericalProperty 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