IsFileEncrypted function

This method is deprecated.

Determines if a given file is stored in FESF encrypted format.

Syntax

HRESULT

IsFileEncrypted(

    [in]           REFGUID Volume,

    [in]           BSTR    Path,

    [out, retval]  VARIANT_BOOL* Encrypted

)

Parameters

Volume [in]

A reference to a GUID that identifies the volume on which the file resides.  See Remarks for further information.

Path [in]

A string containing the path of a file to check.  This may be a fully qualified path or a path relative to the Volume argument.  Refer to the Remarks section.

Encrypted [out, retval]

A pointer to a VARIANT_BOOL that will receive the result on success.  Set to VARIANT_TRUE if the file indicated by Path is in FESF encrypted format.

Return value

S_OK on success

E_FAIL if the file cannot be opened for read access, the required privileges are not available to the caller, or for various other fatal error conditions.

Other standard HRESULT values may be returned indicating the failure of the operation.

Remarks

Important: This method is deprecated and is pending removal from FESF. Do not use it. Convert existing code that uses it as soon as possible. Use the equivalent function provided by the FesfUtil2 Library.

If Volume is equal to FE_NETWORK_GUID (indicating that Path refers to a file on a network volume), then Path is interpreted as a fully qualified path, suitable for direct evaluation.

If Volume is equal to FE_SHADOW_VOLUME_GUID (indicating that Path refers to a file on a shadow volume), then Path is interpreted as either as a fully qualified path, suitable for direct evaluation or as the concatenation of the shadow device name and path.

If Volume is equal to GUID_NULL (indicating that no GUID is provided) then Path is inspected and treated as though either FE_SHADOW_VOLUME_GUID or FE_NETWORK_GUID was provided.

Otherwise, Volume represents a local volume and Path is interpreted as relative to that volume.

In most cases, the calling COM client must have read access to the file.

Examples

See Also

The provided UM_Sample solution contains examples that illustrates the use of this function.

Requirements