IFhReassociation::GetConfigurationDetails method (fhcfg.h)

Article
02/22/2024

This method enumerates File History configurations that were discovered on a storage device or network share by the IFhReassociation::ScanTargetForConfigurations method and returns additional information about each of the discovered configurations.

Note

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

Syntax

HRESULT GetConfigurationDetails(
  [in]  DWORD    Index,
  [out] BSTR     *UserName,
  [out] BSTR     *PcName,
  [out] FILETIME *BackupTime
);

Parameters

[in] Index

Zero-based index of a discovered configuration.

[out] UserName

On return, contains a pointer to a string allocated with SysAllocString containing the name of the user account under which the configuration was last backed up to.

[out] PcName

On return, contains a pointer to a string allocated with SysAllocString containing the name of the computer from which the configuration was last backed up.

[out] BackupTime

On return, contains the date and time when the configuration was last backed up.

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.

If there is no File History configuration with the specified index, the HRESULT_FROM_WIN32(ERROR_NOT_FOUND) error code is returned.

Remarks

The caller is responsible for releasing the memory allocated for UserName and PcName by calling SysFreeString on each of them.

In order to perform reassociation, one of the configurations enumerated by this method must be selected using the IFhReassociation::SelectConfiguration method and then the IFhReassociation::PerformReassociation method needs to be called.

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