Share via


GetFailureInfo method of the MSFT_FSRMAdr class

Retrieves information from the server when a client fails to access a file describing why the failure occurred.

Syntax

uint64 GetFailureInfo(
  [in]  string Path,
  [in]  string ServerPath,
  [in]  uint32 Event,
  [in]  uint32 LocaleId,
  [out] uint32 DisplayFlag[],
  [out] string ErrorMessage,
  [out] string DeviceClaim[]
);

Parameters

Path [in]

The path value. Must not exceed the value of MAX_PATH (260).

ServerPath [in]

A valid path on the server. Must not exceed the value of MAX_PATH (260).

Event [in]

Describes the type of failure handled by ADR.

AccessDenied (1)

The failure was an access denied error.

FileNotFound (2)

The failure was a file not found error.

LocaleId [in]

Reserved for future use. Set to 0.

DisplayFlag [out]

AllowEmailRequests (1)

ShowDeviceTroubleShooting (2)

Returns an array of flags describing how the failure information is presented.

ErrorMessage [out]

Returns the error message in a string value up to 4 KB in length.

DeviceClaim [out]

Returns the names of device claims that dictate the access to the requested file.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\FSRM
MOF
MSFT_FSRM.mof
DLL
SrmSvc.dll

See also

MSFT_FSRMAdr