Appendix 4 - HaloCORE File API Parameters

IT_ATTRB_VALS 

This parameter is deprecated; please do not use it.

IV_DO_LABEL 

If set to ABAP_TRUE, the file will be labeled with the classification determined by HaloCORE , and with any classification, information passed directly to the API (see parameter IT_ATTRB_VALS).
(Please be aware that other system settings controlling the applicability of labeling remain functional and can also influence the outcome.)

IV_DO_PROTECT 

If set to ABAP_TRUE, the file will be protected with RMS, provided a suitable policy is passed or can be determined based on classification.
(Please be aware that other system settings controlling the applicability of RMS protection remain functional and can also influence the outcome.)

IV_FILECONT

Receives the binary content of the file to be protected.

IV_FULLPATH 

Receives the file name (preceded by the path, if available) of the file to be protected.

IV_TPLID 

UID of the Policy to be used for protection. If omitted, and IV_DO_PROTECT is set, a policy will be determined based on classification.

If the passed policy ID is not valid, or the policy is not active, or the user does not have the authorization to use it,

processing is aborted, and the file remains unchanged.

EV_FILECONT

Contains the binary content of the processed file.

EV_FULLPATH

Receives the file name (preceded by the path, if one was contained in parameter IV_FULLPATH) of the processed file.

The resulting filename is usually different than the original one if the file was protected with the generic RMS file protector (PFile);

for Office2003, Office2007 (and later), and PDF documents, the file name usually remains unchanged.

EV_UNCHANGED

Returns ABAP_TRUE if HaloCORE did not change the file. This can for instance occur if:

• no valid policy was indicated or could be found.

• neither RMS protection nor labeling were requested.

• only labeling was requested, but the file type or system settings do not allow this.

• issues occurred during the processing.