OutputFile Property
The file to which output data should be written.
Syntax
amazonkms.getOutputFile([callback]) amazonkms.setOutputFile( outputFile, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getOutputFile([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setOutputFile([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property specifies the file to which data output from a successful cryptographic operation should be written.
Note: For the Verify operation, the specified file functions as a secondary input file instead (along with InputFile); refer to the Verify method for more information.
Input Sources & Output Destinations
The class automatically determines 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:
The first valid input source found is used. The order in which the output properties are considered is as follows:
- The OutputFile property
- The OutputData property
Data Type
String