Contains C API definitions for content label. More...
#include "mip_cc/common_types_cc.h"#include "mip_cc/error_cc.h"#include "mip_cc/mip_macros_cc.h"#include "mip_cc/result_cc.h"#include "mip_cc/upe/label_cc.h"#include "mip_cc/upe/metadata_dictionary_cc.h"#include "mip_cc/dictionary_cc.h"
Include dependency graph for content_label_cc.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
| typedef mip_cc_handle * | mip_cc_content_label |
Functions | |
| MIP_CC_API (mip_cc_result) MIP_CC_ContentLabel_GetCreationTime(const mip_cc_content_label contentLabel | |
| Gets time when label was applied. | |
| MIP_CC_API (void) MIP_CC_ReleaseContentLabel(mip_cc_content_label contentLabel) | |
| Release resources associated with a content label. | |
Variables | |
| mip_cc_label_assignment_method * | assignmentMethod |
| int64_t * | creationTime |
| int64_t mip_cc_error * | errorInfo |
| bool * | isProtectionAppliedByLabel |
| mip_cc_label * | label |
| mip_cc_metadata_dictionary * | properties |
Detailed Description
Contains C API definitions for content label.
Definition in file content_label_cc.h.
Typedef Documentation
◆ mip_cc_content_label
| typedef mip_cc_handle* mip_cc_content_label |
Definition at line 43 of file content_label_cc.h.
Function Documentation
◆ MIP_CC_API() [1/2]
| MIP_CC_API | ( | mip_cc_result | ) | const |
Gets time when label was applied.
Gets generic label properties from a content label instance.
Gets whether or not a protection was applied by a label.
Gets extended properties.
Gets label assignment method.
- Parameters
-
contentLabel Label creationTime [Output] Time when label was applied to document (in seconds since epoch) errorInfo [Output] (Optional) Failure info if operation result is error
- Returns
- Result code indicating success or failure
- Parameters
-
contentLabel Label assignmentMethod [Output] Assignment method (e.g. 'standard' or 'privileged') errorInfo [Output] (Optional) Failure info if operation result is error
- Returns
- Result code indicating success or failure
- Parameters
-
contentLabel Label properties [Output] Dictionary of extended properties, memory owned by caller errorInfo [Output] (Optional) Failure info if operation result is error
- Returns
- Result code indicating success or failure
- Note
- The 'properties' variable must be released by the caller by calling MIP_CC_ReleaseDictionary
- Parameters
-
contentLabel Label isProtectionAppliedByLabel [Output] If document is protected and the protection was explicitly applied by this label. errorInfo [Output] (Optional) Failure info if operation result is error
- Returns
- Result code indicating success or failure
- Parameters
-
contentLabel Label label [Output] Generic label, memory owned by caller errorInfo [Output] (Optional) Failure info if operation result is error
- Returns
- Result code indicating success or failure
- Note
- The 'label' variable must be released by the caller by calling MIP_CC_ReleaseLabel
◆ MIP_CC_API() [2/2]
| MIP_CC_API | ( | void | ) |
Release resources associated with a content label.
- Parameters
-
contentLabel Label to be released
Variable Documentation
◆ assignmentMethod
| mip_cc_label_assignment_method* assignmentMethod |
Definition at line 77 of file content_label_cc.h.
◆ creationTime
| int64_t* creationTime |
Definition at line 63 of file content_label_cc.h.
◆ errorInfo
| mip_cc_label mip_cc_error* errorInfo |
Definition at line 64 of file content_label_cc.h.
◆ isProtectionAppliedByLabel
| bool* isProtectionAppliedByLabel |
Definition at line 107 of file content_label_cc.h.
◆ label
| mip_cc_label* label |
Definition at line 123 of file content_label_cc.h.
◆ properties
| mip_cc_metadata_dictionary* properties |
Definition at line 93 of file content_label_cc.h.
