DPAPI Component
Properties Methods Events Configuration Settings Errors
The DPAPI component allows you to protect and unprotect data.
Syntax
nsoftware.IPWorksEncrypt.Dpapi
Remarks
The DPAPI component the Microsoft Windows Data Protection API (DPAPI) to protect and unprotect data. Protected data is secured by the operating system. The protected data may then be stored by your application and unprotected at a later time.
To get started with the component simply specify input data and call Protect.
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
No other values are required by default. Optional properties such as DataDescription, PromptUser, and PromptTitle allow you to control additional behavior.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| DataDescription | The description of data. |
| InputFile | The file to process. |
| InputMessage | The message to process. |
| OutputFile | The output file. |
| OutputMessage | The output message after processing. |
| Overwrite | Indicates whether or not the component should overwrite files. |
| Password | An optional password to further protect data. |
| PromptTitle | The title of the prompt window. |
| PromptUser | Whether to display a prompt. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Protect | Protects the data. |
| Reset | Resets the component. |
| SetInputStream | Sets the stream from which the component will read data to encrypt or decrypt. |
| SetOutputStream | Sets the stream to which the component will write encrypted or decrypted data. |
| Unprotect | Unprotects the data. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Progress | Fired as progress is made. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| ProtectionFlags | Used to specify additional options. |
| CodePage | The system code page used for Unicode to Multibyte translations. |