Gets label ID.
Gets policy-defined custom settings of a label.
Gets the children labels.
Gets the number of children labels.
Gets the parent label, if any.
Gets whether or not a label is active.
Gets label auto-classification tooltip.
Gets size of buffer required to store auto-classification tooltip.
Gets label tooltip.
Gets size of buffer required to store tooltip.
Gets sensitivity level of label. Higher value means more sensitive.
Gets label color.
Gets size of buffer required to store color.
Gets label description.
Gets size of buffer required to store description.
Gets label name.
Gets size of buffer required to store name.
- Parameters
-
| label | Label |
| labelId | [Output] Label ID |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| nameSize | [Output] Size of buffer to hold name (in number of chars) |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| nameBuffer | [Output] Buffer the name will be copied into. |
| nameBufferSize | Size (in number of chars) of the nameBuffer. |
| actualNameSize | [Output] Number of chars written to the buffer |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If nameBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualNameSize will be set to the minimum required buffer size.
- Parameters
-
| label | Label |
| descriptionSize | [Output] Size of buffer to hold description (in number of chars) |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| descriptionBuffer | [Output] Buffer the description will be copied into. |
| descriptionBufferSize | Size (in number of chars) of the descriptionBuffer. |
| actualDescriptionSize | [Output] Number of chars written to the buffer |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If descriptionBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualDescriptionSize will be set to the minimum required buffer size.
- Parameters
-
| label | Label |
| colorSize | [Output] Size of buffer to hold color (in number of chars) |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| colorBuffer | [Output] Buffer the color will be copied into (in #RRGGBB format). |
| colorBufferSize | Size (in number of chars) of the colorBuffer. |
| actualColorSize | [Output] Number of chars written to the buffer |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If colorBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualColorSize will be set to the minimum required buffer size.
- Parameters
-
| label | Label |
| sensitivity | [Output] Sensitivity level |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| tooltipSize | [Output] Size of buffer to hold tooltip (in number of chars) |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| tooltipBuffer | [Output] Buffer the tooltip will be copied into. |
| tooltipBufferSize | Size (in number of chars) of the tooltipBuffer. |
| actualTooltipSize | [Output] Number of chars written to the buffer |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If tooltipBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualTooltipSize will be set to the minimum required buffer size.
- Parameters
-
| label | Label |
| isActive | [Output] Whether or not a label is considered active. |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- Only active labels can be applied. Inactivte labels cannot be applied and are used for display purposes only.
- Parameters
-
| label | Label |
| parent | [Output] Parent label, if any, else null |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| childrenSize | [Output] Number of children |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Parameters
-
| label | Label |
| childrenBuffer | [Output] Buffer the children labels will be copied into. Children labels are owned by the caller and must be released with MIP_CC_ReleaseLabel. |
| childrenBufferSize | Size (in number of labels) of the childrenBuffer. |
| actualChildrenSize | [Output] Number of children labels written to the buffer |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- If childrenBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualChildrenSize will be set to the minimum required buffer size
- Parameters
-
| label | Label |
| settings | [Output] Dictionary of settings, owned by the caller |
| errorInfo | [Output] (Optional) Failure info if operation result is error |
- Returns
- Result code indicating success or failure
- Note
- The 'settings' variable must be released by the caller by calling MIP_CC_ReleaseDictionary
1.12.0