Export (0) Print
Expand All
Expand Minimize

FileEncryptionStatus function

Retrieves the encryption status of the specified file.

Syntax


BOOL WINAPI FileEncryptionStatus(
  _In_   LPCTSTR lpFileName,
  _Out_  LPDWORD lpStatus
);

Parameters

lpFileName [in]

The name of the file.

lpStatus [out]

A pointer to a variable that receives the encryption status of the file. This parameter can be one of the following values.

ValueMeaning
FILE_ENCRYPTABLE
0

The file can be encrypted.

Home, Home Premium, Starter, and ARM Editions of Windows:  FILE_ENCRYPTABLE may be returned but EFS does not support encrypting files on these editions of Windows.

FILE_IS_ENCRYPTED
1

The file is encrypted.

FILE_READ_ONLY
8

The file is a read-only file.

FILE_ROOT_DIR
3

The file is a root directory. Root directories cannot be encrypted.

FILE_SYSTEM_ATTR
2

The file is a system file. System files cannot be encrypted.

FILE_SYSTEM_DIR
4

The file is a system directory. System directories cannot be encrypted.

FILE_SYSTEM_NOT_SUPPORT
6

The file system does not support file encryption.

FILE_UNKNOWN
5

The encryption status is unknown. The file may be encrypted.

FILE_USER_DISALLOWED
7

Reserved for future use.

 

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

In Windows 8 and Windows Server 2012, this function is supported by the following technologies.

TechnologySupported

Server Message Block (SMB) 3.0 protocol

Yes

SMB 3.0 Transparent Failover (TFO)

No

SMB 3.0 with Scale-out File Shares (SO)

No

Cluster Shared Volume File System (CsvFS)

No

Resilient File System (ReFS)

No

 

SMB 3.0 does not support EFS on shares with continuous availability capability.

Requirements

Minimum supported client

Windows XP Professional [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinBase.h (include Windows.h)

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

FileEncryptionStatusW (Unicode) and FileEncryptionStatusA (ANSI)

See also

EncryptFile
File Encryption
File Management Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft