DPC-0225 Storage Protection Management Software

Transcription

1 Storage Protection Management Software DPC-0225 Storage Protection Management Software Ver.1.10 Help for Windows

2 Contents Chapter 1 Introduction Overview Features...3 Chapter 2 Product Specifications Functional Specifications Product Composition...5 Chapter 3 Programming Guide Installation Programming Guide for Memory Monitoring Library...6 Chapter 4 Reference List of DLL Functions DLL Functions Return Value...11 Chapter 5 Sample Programs Execution Procedure List of Sample Programs...12 Chapter 6 Storage Protection Utility Starting the Utility Displaying the Window Confirming the Version Closing the Utility Forcibly Utility Window Using the Utility...18 Chapter 7 Batch Files List of Batch Files IFUWFfilterenable.bat IFUWFfilterdisable.bat IFUWFvolumeprotect.bat IFUWFvolumeunprotect.bat IFUWFadd-exclusion.bat IFUWFremove-exclusion.bat IFUWFget-exclusion.bat Examples of Using Batch File...38 Chapter 8 Terms of Use 39 2

3 Chapter 1 Introduction 1.1 Overview The Storage Potection Management Software manages write-accesses to volumes using UWF. It consists of Storage Protection Utility program, batch files for UWF configuration, and Memory Monitoring Library. - Storage Protection Utility Program: Configures UWF protection and monitors memory usage with GUI. - Batch files for UWF configuration: Allows you to easily configure UWF. - Memory Monitoring Library: Monitors memory usage of UWF from an application program running on Windows. This document provides information to use the Storage Protection Utility program. This software is bilingual software and includes Japanese and English documents. 1.2 Features - UWF can be easily configured on the utility program. - The memory usage of UWF and the size of free physical memory can be confirmed on the utility program. When the values exceed the threshold, this program notices the user by using a balloon. - UWF can be easily configured by using the batch files. - The memory usage of UWF and physical memory can be retrieved by using the library. 3

4 Chapter 2 Product Specifications 2.1 Functional Specifications Item Storage Protection Utility Program Batch File Memory Monitoring Library Memory Usage of UWF Physical Memory Size - Enables/disables UWF protection - Adds/deletes a volume to/from the volume protection list. - Monitors the memory usage of UWF and the size of free physical memory - Enables/disables UWF protection - Adds/deletes a volume to/from the volume protection list - Adds/deletes a file or folder to/from the file exclusion list. - Retrieves the memory usage of UWF. - Retrieves the total size of physical memory and the size of free physical memory. 4

5 2.2 Product Composition Product Composition File Name Management file DPC0225.ver Management information file for Interface Corporation use Latest Information readme.htm The latest information document (Japanese) readme_e.htm The latest information document (English) Help Help.pdf Help (PDF format)(japanese) Help_e.pdf Help (PDF format)(english) Refarence file for document.txt Refarence file for documents (Japanese) documents document_e.txt Refarence file for documents (English) Installer SETUP.EXE Installation program Utility program ifuwf.exe Storage Protection Utility Program Sample programs - - Visual C#.NET Visual C++ Visual Basic.NET Batch file IFCUWF uwfreboot memoryreboot uwfreboot memoryreboot uwfreboot memoryreboot IFUWFfilterenable.bat IFUWFfilterdisable.bat IFUWFvolumeprotect.bat IFUWFvolumeunprotect.bat IFUWFadd-exclusion.bat IFUWFremove-exclusion.bat IFUWFget-exclusion.bat Class library Monitors the memory usage of UWF. If the usage is greater than the threshold, the sample program restarts the system. Monitors the size of free physical memory. If the size is smaller than the threshold, the sample program restarts the system. Monitors the memory usage of UWF. If the usage is greater than the threshold, the sample program restarts the system. Monitors the size of free physical memory. If the size is smaller than the threshold, the sample program restarts the system. Monitors the memory usage of UWF. If the usage is greater than the threshold, the sample program restarts the system. Monitors the size of free physical memory. If the size is smaller than the threshold, the sample program restarts the system. Enables UWF protection. Disables UWF protection. Adds the specified volume to the list of volumes that are protected by UWF Removes the specified volume from the list of volumes that are protected by UWF. Adds the specified file to the file exclusion list of the volume protected by UWF. Removes the specified file from the file exclusion list of the volume protected by UWF. Displays all files and folders in the exclusion list for the specified volume. * Sample programs for Visual C#,.NET and Visual Basic.NET are created using Visual C#.NET 2015 and Visual Basic.NET 2015, respectively. 5

6 Chapter 3 Programming Guide 3.1 Installation Refer to README for installation. 3.2 Programming Guide for Memory Monitoring Library This section explains basic control procedures. The examples are written i C# Retrieving Memory Usage of UWF The IfUwfGetUwfRamData function retrieves memory usage of UWF in megabyte (MB). uint ret; uint RamDataBytes; // Retrieves memory usage of UWF ret = IFCUWF.IfUwfGetUwfRamData(out RamDataBytes); Retrieving the Total Size of Physical Memory and the Size of Free Physical Memory The IfUwfGetPhysicalMemory function retrieves the total size of physical memory and the size of free physical memory in megabyte (MB). uint ret; uint TotalBytes; uint FreeBytes; // Retrieves the total size of physical memory ret = IFCUWF.IfUwfGetPhysicalMemory(out TotalBytes, out FreeBytes); 6

7 Chapter 4 Reference 4.1 List of DLL Functions No Function Memory usage of UWF 1 IfUwfGetUwfRamData Retrieves memory usage of UWF. Physical memory size 2 IfUwfGetPhysicalMemory Retrieves the total size of physical memory and the size of free physical memory. 7

8 4.2 DLL Functions 1. IfUwfGetUwfRamData The function retrieves memory usage of UWF. Syntax Visual C unsigned int IfUwfGetUwfRamData ( unsigned int* pramdatabytes ); Visual C#.NET uint IfUwfGetUwfRamData ( out uint pramdatabytes ); Visual Basic.NET Function IfUwfGetUwfRamData ( _ ByRef pramdatabytes As UInteger _ )As UInteger Parameter pramdatabytes The parameter points to a variable to receive memory usage of UWF. The unit is megabyte (MB). Return Value The function returns IFCUWF_ERROR_SUCCESS when the process is successfully completed. If the function returns any other value, refer to "4.3 Return Value". Examples Retrieving memory usage of UWF Visual C unsigned int ret; unsigned int RamDataBytes; ret = IFCUWF::IfUwfGetUwfRamData(RamDataBytes); Visual C#.NET uint ret; uint RamDataBytes; ret = IFCUWF.IfUwfGetUwfRamData(out RamDataBytes); Visual Basic.NET Dim ret As UInteger Dim RamDataBytes As UInteger ret = IFCUWF.IfUwfGetUwfRamData(RamDataBytes) 8

9 2. IfUwfGetPhysicalMemory The function retrieves the total size of physical memory and the size of free physical memory. Syntax Visual C unsigned int IfUwfGetPhysicalMemory ( unsigned int* ptotalbytes, unsigned int* pfreebytes ); Visual C#.NET uint IfUwfGetPhysicalMemory ( out uint ptotalbytes, out uint pfreebytes ); Visual Basic.NET Function IfUwfGetPhysicalMemory ( _ ByRef ptotalbytes As UInteger, _ ByRef pfreebytes As UInteger _ )As UInteger Parameters ptotalbytes The parameter points to a variable to receive the total size of physical memory. The unit is megabyte (MB). pfreebytes The parameter points to a variable to receive the size of free physical memory. The unit is megabyte (MB). Return Value The function returns IFCUWF_ERROR_SUCCESS when the process is successfully completed. If the function returns any other value, refer to "4.3 Return Value". 9

10 Examples Retrieving the total size of physical memory and the size of free physical memory Visual C unsigned int ret; unsigned int TotalBytes; unsigned int FreeBytes; ret = IFCUWF::IfUwfGetPhysicalMemory(TotalBytes, FreeBytes); Visual C#.NET uint ret; uint TotalBytes; uint FreeBytes; ret = IFCUWF.IfUwfGetPhysicalMemory(out TotalBytes, out FreeBytes); Visual Basic.NET Dim ret As UInteger Dim TotalBytes As UInteger Dim FreeBytes As UInteger ret = IFCUWF.IfUwfGetPhysicalMemory(TotalBytes, FreeBytes) 10

11 4.3 Return Value Error Code Value Comments/Solutions IFCUWF_ERROR_SUCCESS h Successful completion - IFCUWF_ERROR_GET_ INFORMATION C h Information retrieval failure Check the operation environment. 11

12 Chapter 5 Sample Programs This chapter explains the overview of sample programs. 5.1 Execution Procedure Executable file of the sample program is not included in this product. Compile the source code and create an executable file to start. Visual C++ 1. Start Visual Studio. 2. Select File > Open > Project/Solution. 3. Open the project file, " *.vcproj". 4. Build the project file. Visual C#.NET 1. Start Visual Studio. 2. Select File > Open > Project/Solution. 3. Open the project file, "*.csproj". 4. Build the project file. Visual Basic.NET 1. Start Visual Studio. 2. Select File > Open > Project/Solution. 3. Open the project file, "*.vbproj". 4. Build the project file. 5.2 List of Sample Programs Sample Program uwfreboot memoryreboot This sample program monitors whether memory usage of UWF is greater than 256 MB every second. When the memory usage of UWF is greater than 256 MB, the sample program restarts the system. The program monitors whether the size of free physical memory is smaller than 128 MB every second. When the free size of physical memory is smaller than 128 MB, the sample program restarts the system. 12

13 Chapter 6 Storage Protection Utility The Storage Protection Utility has the following capabilities: - Enabling and Disabling UWF - Setting UWF-protection and cancellation of UWF-protection of volume. - Monitoring the memory usage of UWF and the size of free physical memory - Displaying a warning message by using a balloon when the values of the memory usage of UWF and the size of free physical memory exceed the specified threshold. 6.1 Starting the Utility This utility starts automatically when the system starts. The utility runs as a memory resident program. To know if it is running or not, see the task tray. While it is running, the Storage Protection Utility icon is displayed on the system tray. Storage Protection Utility icon If you close the utility and the icon is not displayed on the system tray, run <installation destination> interface DPC0225 bin ifuwf.exe to start the utility. 6.2 Displaying the Window To open the window of the Storage Protection Utility use either of the following two methods. Method 1 Double-click the Storage Protection Utility icon. Storage Protection Utility icon 2 Right-click on the Storage Protection Utility icon and click Open. 13

14 Administrator privileges are required to open the utility window. Click Yes and continue if the following dialog box appears. Note If the program fails to retrieve information of UWF, the following dialog box appears. In this case, make sure that the operating environment satisfies all of the following conditions. No. Condition 1 The write protection switch is disabled on the product that supports write protection of SSD. 2 The utility program runs with administrator privileges. 3 The UWF package is correctly installed in the system. If the operating environment does not satisfy the conditions described above, the error may occur. 14

15 6.3 Confirming the Version To confirm the version of the utility, follow the steps below. Step 1 Right-click on the Storage Protection Utility icon and click Information. 2 The following dialog box appears. The version is shown at the position of the red frame. 6.4 Closing the Utility Forcibly To close the utility, follow the step below. Step 1 Right-click on the Storage Protection Utility icon and click Exit. 15

16 6.5 Utility Window Utility Window (1) (2) (3) (4) (5) (6) (7) (8) (9) No. 1 The item enables or disables UWF protection. Select the check box to enable UWF protection or clear the check box to disable UWF protection. * To reflect any change, you need to restart the system. 2 The item adds/deletes the specified volume to/from the volume UWF protection list. Select the check box to protect the volume or clear the check box not to protect the volume. * To reflect any change, you need to restart the system. 3 The item sets a threshold for the memory usage of UWF and enables a warning message. Select the check box to enable the warning message or clear the check box to disable the warning message. A warning message appears when the memory usage of UWF is greater than the threshold specified here. 4 The item shows the memory usage of UWF. The unit is megabyte (MB). 16

17 No. 5 The item sets a threshold for the size of free physical memory and enables a warning message. Select the check box to enable the warning message or clear the check box to disable the warning message. A warning message appears when the size of free physical memory is smaller than the threshold specified here. 6 The item shows the size of free physical memory. The unit is megabyte (MB). 7 The item shows the total size of physical memory. The unit is megabyte (MB). 8 Click OK to reflect changes and close the dialog box. After clicking the OK button, the following dialog boxes appear. Follow the instructions on the dialog boxes and reflect changes. If the changes you made are only the threshold and warning message of the size of free physical memory and memory usage of UWF at number 3 and 5, you do not have to restart the system. The second dialog box above that asks you if you want to restart the system will not appear. 9 Click Cancel to discard changes and close the dialog box. 17

18 6.6 Using the Utility Protecting Drive C Step 1 Open the window of the Storage Protection Utility by using either of the following two methods. 1. Double-click the Storage Protection Utility icon. 2. Right-click on the Storage Protection Utility icon and click Open. 2 (1) Select the check box of UWF Filter. (2) Select the check box of C in UWF Volume. (3) Click OK. (1) (2) (3) 3 The following dialog box appears. Confirm the message and click OK. 18

19 Step Note The following dialog box appears if you click Cancel. Set each item in the window again. 4 The following dialog box appears. Confirm the message and click OK. When you click OK, the system will restart. Note The following dialog box appears if you click Cancel. Set each item in the window again. 19

20 Step 5 After the system restarts, open the utility window and confirm that the properties are configured as follows. - The check box of UWF Filter is selected. - The check box of C in UWF Volume is selected. 20

21 6.6.2 Cancelling the Protection for Drive C Step 1 Open the window of the Storage Protection Utility by using either of the following two methods. 1. Double-click the Storage Protection Utility icon. 2. Right-click on the Storage Protection Utility icon and click Open. 2 (1) Clear the check box of UWF Filter. (2) Clear the check box of C in UWF Volume. (3) Click OK. (1) (2) (3) 3 The following dialog box appears. Confirm the message and click OK. Note The following dialog box appears if you click Cancel. Set each item in the window again. 21

22 Step 4 The following dialog box appears. Confirm the message and click OK. When you click OK, the system will restart. Note The following dialog box appears if you click Cancel. Set each item in the window again. 5 After the system restarts, open the utility window and confirm that the the properties are configured as follows. - The check box of UWF Filter is cleared. - The check box of C in UWF Volume is cleared. 22

23 6.6.3 Adding Drive C to and Deleting Drive D from the Protection List Step 1 Open the window of the Storage Protection Utility by using either of the following two methods. 1. Double-click the Storage Protection Utility icon. 2. Right-click on the Storage Protection Utility icon and click Open. 2 (1) Select the check box of UWF Filter. (2) Select the check box of C and clear the check box of D in UWF Volume. (3) Click OK. (1) (2) (3) 3 The following dialog box appears. Confirm the message and click OK. 23

24 Step Note The following dialog box appears if you click Cancel. Set each item in the window again. 4 The following dialog box appears. Confirm the message and click OK. When you click OK, the system will restart. Note The following dialog box appears if you click Cancel. Set each item in the window again. 24

25 Step 5 After the system restarts, open the utility window and confirm that properties are configured as follows. - The check box of UWF Filter is selected. - The check box of C in UWF Volume is selected. - The check box of D in UWF Volume is cleared. 25

26 6.6.4 Monitoring the Memory Usage of UWF Step 1 Open the window of the Storage Protection Utility by using either of the following two methods. 1. Double-click the Storage Protection Utility icon. 2. Right-click on the Storage Protection Utility icon and click Open. 2 (1) Select the check box of UWF Threshold. (2) Type a threshold in the text box of UWF Threshold. (3) Click OK. (1) (2) (3) 3 The following dialog box appears. Confirm the message and click OK. Note The following dialog box appears if you click Cancel. Set each item in the window again. 26

27 Step 4 Open the utility window and confirm that the properties are configured as follows. - The check box of UWF Threshold is selected. - The typed value is displayed in the text box of UWF Threshold. 27

28 6.6.5 Monitoring the Size of Free Physical Memory Step 1 Open the window of the Storage Protection Utility by using either of the following two methods. 1. Double-click the Storage Protection Utility icon. 2. Right-click on the Storage Protection Utility icon and click Open. 2 (1) Select the check box of Free Threshold. (2) Type a value in the text box of Free Threshold. (3) Click OK. (1) (2) (3) 3 The following dialog box appears. Confirm the message and click OK. 28

29 Step Note The following dialog box appears if you click Cancel. Set each item in the window again. 4 After the system restarts, open the utility window and confirm that the properties are configured as follows. - The check box of Free Threshold is selected. - The typed value is displayed in the text box of Free Threshold. 29

30 Chapter 7 Batch Files This chapter explains the outline of the batch files. 7.1 List of Batch Files File Name IFUWFfilterenable.bat IFUWFfilterdisable.bat IFUWFvolumeprotect.bat IFUWFvolumeunprotect.bat IFUWFadd-exclusion.bat IFUWFremove-exclusion.bat IFUWFget-exclusion.bat Enables UWF protection. Disables UWF protection. Adds the specified volume to the list of volumes that are protected by UWF. Removes the specified volume from the list of volumes that are protected by UWF. Adds the specified file to the file exclusion list of the volume protected by UWF. Removes the specified file from the file exclusion list of the volume protected by UWF. Displays all files and folders in the exclusion list for the specified volume. 30

31 7.2 IFUWFfilterenable.bat The batch file enables UWF protection. Content Content of the batch file > uwfmgr filter enable Notes - Run the batch file when UWF is disabled. The batch file does not affect the protection if UWF is enabled. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 31

32 7.3 IFUWFfilterdisable.bat The batch file disables UWF protection. Content Content of the batch file > uwfmgr filter disable Notes - Run the batch file when UWF is enabled. The batch file does not affect the protection if UWF is disabled. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 32

33 7.4 IFUWFvolumeprotect.bat The batch file adds the specified volume to the list of volumes that are protected by UWF. Content Content of the batch file > uwfmgr volume protect c: Notes - Run the batch file when the volume is not protected. The batch file does not affect the protection if the volume is protected. - The batch file protects drive C. To protect drive D or the other drives, change the content of the batch file. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 33

34 7.5 IFUWFvolumeunprotect.bat The batch file removes the specified volume from the list of volumes that are protected by UWF. Content Content of the batch file > uwfmgr volume unprotect c: Notes - Run the batch file when the volume is protected. The batch file does not affect the protection if the volume is not protected. - The batch file removes drive C from the list of volumes that are protected by UWF. To removes drive D or the other drives from the list of volumes that are protected by UWF, change the content of the batch file. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 34

35 7.6 IFUWFadd-exclusion.bat The batch file adds the specified file or folder to the file exclusion list of the volume protected by UWF. Content Content of the batch file > uwfmgr file add-exclusion C: temp Notes - Run the batch file when the files/folders are protected. The batch file does not affect protection if the files/folders are excluded from protection. - The batch file excludes the C: temp folder from protection. To exclude other folders from protection, change the content of the batch file. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. - This batch file is not applicable to some file systems including exfat. Refer to Microsoft website for details. - Some folders including the Windows System32 folder cannot be excluded from protection. Refer to Microsoft website for details. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 35

36 7.7 IFUWFremove-exclusion.bat The batch file removes the specified file or folder from the file exclusion list of the volume protected by UWF. Content Content of the batch file > uwfmgr file remove-exclusion C: temp Notes - Run the batch file when the files/folders are excluded from protection. The batch file does not affect the protection if the files/folders are protected. - The batch file protects the C: temp folder. To protect other folders, change the content of the batch file. - Run the batch file with administrator privileges. - Restart the system after you change settings by using the batch file. - This batch file is not applicable to some file systems including exfat. Refer to Microsoft website for details. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 36

37 7.8 IFUWFget-exclusion.bat The batch file displays all files and folders in the exclusion list for the specified volume. Content Content of the batch file > uwfmgr file get-exclusions Notes - Run the batch file with administrator privileges. Example of Execution Result When the batch file is successfully completed, the execution result is shown as follows. 37

38 7.9 Examples of Using Batch File This section explains how to protect a volume, folder, and/or file by using UWF. Handling Adding drive C to the list of volumes that are protected by UWF Removeing drive C from the list of volumes that are protected by UWF Procedure 1. Run IFUWFfilterenable.bat to enable UWF protection. 2. Run IFUWFvolumeprotect.bat to protect drive C. 3. Restart the system to reflect the changes. 1. Run IFUWFvolumeunprotect.bat to remove the drive C from the list of volumes that are protected by UWF. 2. Run IFUWFfilterdisable.bat to disable UWF protection. Removing folders from the file exclusion list of the volume protected by UWF 3. Restart the system to reflect the changes. 1. Run IFUWFfilterenable.bat to enable UWF protection. 2. Run IFUWFvolumeprotect.bat to protect drive C. 3. Run IFUWFadd-exclusion.bat to exclude a folder in drive C from protection. 4. Restart the system to reflect the changes. 38

39 Chapter 8 Terms of Use Limited Warranty Interface Corporation does not warrant uninterrupted or error-free operations of the software product. The entire risks as to the quality of or arising out of use or performance of the software products, if any, remains with you. Interface believes that information contained in the document is accurate. The document is carefully reviewed for technical accuracy. Interface reserves the right to make changes to subsequent editions of this document without prior notice to holders of this edition. Interface is not liable for any damages arising out of or related to this document or the information contained in it. Charts and tables contained in this document are only for illustration purposes and may vary depending upon a user's specific application program. All official specifications are in metric. English unit is supplied for convenience. Copyrights and Intellectual Property Rights Interface Corporation owns all titles and intellectual property rights in and to the products. The products include the computer software, audio/visual content such as images, texts, or pictures. Warning Regarding Medical and Clinical Use of Our Products Our products are not designed for components intended to ensure a level of reliability suitable for use under conditions that might cause serious injury or death. Our products are not designed with components and testing instrument intended to ensure a level of reliability suitable for use in treatment and diagnosis of human. Applications of our products involving medical or clinical treatment can create a potential for accidental injury caused by product failure, or by errors on the part of the user or application engineer. Prohibition of Reproduction No part of this document may be reproduced or changed in any form without the prior consent of Interface Corporation. Limitation of Liability Interface Corporation will not be liable for any special, incidental, indirect or consequential damages whatsoever even if Interface Corporation or any reseller could foresee the possibility of damages. Users shall assume any subsequent risks whatsoever resulting from such as using and installing this product. Interface Corporation shall not be liable for any incidental or consequential damages, including damages or other costs resulting from defects which might be contained in the product, product supply delay or product failure. Customer's right to recover damages caused by fault or negligence on the part of Interface Corporation shall be limited to the amount paid by the customer for the product. This product is designed under Japanese domestic specifications. Interface Corporation is not responsible for the use of this product outside Japan. We do not offer any maintenance service or technical support abroad. Interface Corporation is not liable for any damage arising from the included document or information. Trademark Products and company names are trademarks, registered trademarks, or servicemarks of their respective owners. 39