Funciones

mip_cc_auth_callback

definición de función de devolución de llamada para adquirir el token de OAuth2

Parámetros

Parámetro	Descripción
identity	La dirección de correo electrónico para la que se adquirirá el token
challenge	Desafío de OAuth2
context	Contexto de aplicación opaco que se pasó a la API de MIP que dio lugar a esta devolución de llamada de autenticación
tokenBuffer	[Salida] Búfer en el que se copiará el token. Si es null, se rellenará "actualTokenSize", pero
tokenBufferSize	Tamaño (en bytes) del búfer de salida
actualTokenSize	[Salida] Tamaño real (en bytes) del token

Return: True is token was retrieved, else false

MIP_CC_CALLBACK(mip_cc_auth_callback,
    bool,
    const mip_cc_identity*,
    const mip_cc_oauth2_challenge*,
    const void*,
    uint8_t*,
    const int64_t,
    int64_t*);

mip_cc_consent_callback

definición de función de devolución de llamada para el consentimiento del usuario para acceder al punto de conexión de servicio externo

Parámetros

Parámetro	Descripción
url	Dirección URL para la que el SDK requiere el consentimiento del usuario

Devolución: respuesta de consentimiento del usuario

MIP_CC_CALLBACK(mip_cc_consent_callback,
    mip_cc_consent,
    const char*);

MIP_CC_CreateDictionary

Creación de un diccionario de claves y valores de cadena

Parámetros

Parámetro	Descripción
entries	Matriz de pares clave-valor
count	Número de pares clave-valor
diccionario	[Salida] Diccionario recién creado
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Se debe liberar un mip_cc_dictionary llamando a MIP_CC_ReleaseDictionary

mip_cc_result MIP_CC_CreateDictionary(
    const mip_cc_kv_pair* entries,
    const int64_t count,
    mip_cc_dictionary* dictionary,
    mip_cc_error* errorInfo);

MIP_CC_Dictionary_GetEntries

Obtener pares clave-valor que componen un diccionario

Parámetros

Parámetro	Descripción
diccionario	Diccionario de origen
entries	[Salida] Matriz de pares clave-valor, memoria propiedad de mip_cc_dictionary objeto
count	[Salida] Número de pares clave-valor
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: La memoria de "entradas" es propiedad del objeto mip_cc_dictionary, por lo que no debe liberarse de forma independiente.

mip_cc_result MIP_CC_Dictionary_GetEntries(
    const mip_cc_dictionary dictionary,
    mip_cc_kv_pair** entries,
    int64_t* count,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseDictionary

Liberar recursos asociados a un diccionario

Parámetros

Parámetro	Descripción
diccionario	Diccionario que se va a publicar

void MIP_CC_ReleaseDictionary(mip_cc_dictionary dictionary);

mip_cc_http_send_callback_fn

Definición de función de devolución de llamada para emitir una solicitud HTTP

Parámetros

Parámetro	Descripción
request	Solicitud HTTP que va a realizar la aplicación
context	El mismo contexto opaco pasado a la llamada API de MIP que dio lugar a esta solicitud HTTP

MIP_CC_CALLBACK(mip_cc_http_send_callback_fn,
    void,
    const mip_cc_http_request*,
    const void*);

mip_cc_http_cancel_callback_fn

Definición de función de devolución de llamada para cancelar una solicitud HTTP

Parámetros

Parámetro	Descripción
requestId	Identificador de la solicitud HTTP que se va a cancelar.

MIP_CC_CALLBACK(mip_cc_http_cancel_callback_fn,
    void,
    const char*);

MIP_CC_CreateHttpDelegate

Crea un delegado HTTP que se puede usar para invalidar la pila HTTP predeterminada de MIP.

Parámetros

Parámetro	Descripción
sendCallback	Puntero de función para emitir solicitudes HTTP
cancelCallback	Puntero de función para cancelar solicitudes HTTP
httpDelegate	[Salida] Identificador del objeto delegado HTTP
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_CreateHttpDelegate(
    const mip_cc_http_send_callback_fn sendCallback,
    const mip_cc_http_cancel_callback_fn cancelCallback,
    mip_cc_http_delegate* httpDelegate,
    mip_cc_error* errorInfo);

MIP_CC_NotifyHttpDelegateResponse

Notifica a un delegado HTTP que una respuesta HTTP está lista

Parámetros

Parámetro	Descripción
httpDelegate	Identificador del objeto delegado HTTP
requestId	Identificador de la solicitud HTTP asociada a esta operación
resultado	Estado de operación correcta o de error
respuesta	Respuesta HTTP si la operación se realizó correctamente; en caso contrario, nullptr

Nota: La aplicación debe llamar a esta función cuando se haya completado una operación HTTP. El identificador de la respuesta HTTP debe coincidir con el identificador de la solicitud HTTP para permitir que MIP ponga en correlación una respuesta con su solicitud.

void MIP_CC_NotifyHttpDelegateResponse(
    const mip_cc_http_delegate httpDelegate,
    const char* requestId,
    const mip_cc_http_result result,
    const mip_cc_http_response* response);

MIP_CC_ReleaseHttpDelegate

Liberar recursos asociados a un identificador de delegado HTTP

Parámetros

Parámetro	Descripción
httpDelegate	Delegado HTTP que se va a publicar

void MIP_CC_ReleaseHttpDelegate(mip_cc_http_delegate httpDelegate);

mip_cc_logger_init_callback_fn

Definición de función de devolución de llamada para la inicialización del registrador

Parámetros

Parámetro	Descripción
storagePath	Ruta de acceso del archivo donde se pueden almacenar los registros

MIP_CC_CALLBACK(mip_cc_logger_init_callback_fn,
    void,
    const char*);

mip_cc_logger_write_callback_fn

Definición de función de devolución de llamada para escribir una instrucción de registro

Parámetros

Parámetro	Descripción
Nivel	el nivel de registro de la instrucción de registro.
message	el mensaje de la instrucción de registro.
function	el nombre de la función de la instrucción de registro.
archivo	el nombre de archivo donde se generó la instrucción de registro.
line	número de línea donde se generó la instrucción de registro.

MIP_CC_CALLBACK(mip_cc_logger_write_callback_fn,
    void,
    const mip_cc_log_level,
    const char*,
    const char*,
    const char*,
    const int32_t);

MIP_CC_CreateLoggerDelegate

Crea un delegado de registrador que se puede usar para invalidar el registrador predeterminado de MIP.

Parámetros

Parámetro	Descripción
initCallback	Puntero de función para la inicialización
flushCallback	Puntero de función para vaciar registros
writeCallback	Puntero de función para escribir una instrucción de registro
loggerDelegate	[Salida] Identificador del objeto delegado del registrador
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_CreateLoggerDelegate(
    const mip_cc_logger_init_callback_fn initCallback,
    const mip_cc_logger_flush_callback_fn flushCallback,
    const mip_cc_logger_write_callback_fn writeCallback,
    mip_cc_logger_delegate* loggerDelegate,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseLoggerDelegate

Liberar recursos asociados a un identificador de delegado de registrador

Parámetros

Parámetro	Descripción
loggerDelegate	delegado de registrador que se va a liberar

void MIP_CC_ReleaseLoggerDelegate(mip_cc_logger_delegate loggerDelegate);

MIP_CC_CreateMipContext

Creación de un contexto de MIP para administrar el estado compartido en todas las instancias de perfil

Parámetros

Parámetro	Descripción
applicationInfo	Información sobre la aplicación que consume el SDK de protección
path	Ruta de acceso de archivo en la que se almacenan el registro, la telemetría y otras garantías de protección.
logLevel	Nivel de registro mínimo para .miplog
isOfflineOnly	Habilitar o deshabilitar operaciones de red (no todas las acciones admitidas cuando están sin conexión)
loggerDelegateOverride	(Opcional) Implementación de invalidación del registrador
telemetryOverride	(Opcional) Se invalida la configuración de telemetría. Si es NULL, se usará la configuración predeterminada.
mipContext	[Salida] Instancia de contexto de MIP recién creada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_CreateMipContext(
    const mip_cc_application_info* applicationInfo,
    const char* path,
    const mip_cc_log_level logLevel,
    const bool isOfflineOnly,
    const mip_cc_logger_delegate loggerDelegateOverride,
    const mip_cc_telemetry_configuration telemetryOverride,
    mip_cc_mip_context* mipContext,
    mip_cc_error* errorInfo);

MIP_CC_CreateMipContextWithCustomFeatureSettings

Creación de un contexto de MIP para administrar el estado compartido en todas las instancias de perfil

Parámetros

Parámetro	Descripción
applicationInfo	Información sobre la aplicación que consume el SDK de protección
path	Ruta de acceso de archivo en la que se almacenan el registro, la telemetría y otras garantías de protección.
logLevel	Nivel de registro mínimo para .miplog
isOfflineOnly	Habilitar o deshabilitar operaciones de red (no todas las acciones admitidas cuando están sin conexión)
loggerDelegateOverride	(Opcional) Implementación de invalidación del registrador
telemetryOverride	(Opcional) Se ha reemplazado la configuración de telemetría. Si es NULL, se usará la configuración predeterminada.
featureSettings	(Opcional) Matriz de invalidaciones de características personalizadas
featureSettingsSize	Tamaño de invalidaciones de características personalizadas (en número de invalidaciones)
mipContext	[Salida] Instancia de contexto de MIP recién creada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_CreateMipContextWithCustomFeatureSettings(
    const mip_cc_application_info* applicationInfo,
    const char* path,
    const mip_cc_log_level logLevel,
    const bool isOfflineOnly,
    const mip_cc_logger_delegate loggerDelegateOverride,
    const mip_cc_telemetry_configuration telemetryOverride,
    const mip_cc_feature_override* featureSettings,
    const int64_t featureSettingsSize,
    mip_cc_mip_context* mipContext,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseMipContext

Liberar recursos asociados a un contexto de MIP

Parámetros

Parámetro	Descripción
mipContext	Contexto de MIP que se va a liberar

void MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext);

MIP_CC_ProtectionDescriptor_GetProtectionType

Obtiene el tipo de protección, tanto si se define mediante una plantilla de RMS como si no.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
protectionType	[Salida] Tipo de protección
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectionDescriptor_GetProtectionType(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_protection_type* protectionType,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetOwnerSize

Obtiene el tamaño del búfer necesario para almacenar el propietario.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
ownerSize	[Salida] Tamaño del búfer para contener el propietario (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectionDescriptor_GetOwnerSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* ownerSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetOwner

Obtiene el propietario de la protección.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
ownerBuffer	[Salida] Búfer en el que se copiará el propietario.
ownerBufferSize	Tamaño (en número de caracteres) del ownerBuffer.
actualOwnerSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si ownerBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realOwnerSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectionDescriptor_GetOwner(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* ownerBuffer,
    const int64_t ownerBufferSize,
    int64_t* actualOwnerSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
nameSize	[Salida] Tamaño del búfer para contener el nombre (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectionDescriptor_GetNameSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetName

Obtiene el nombre de protección.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
nameBuffer	[Salida] Búfer en el que se copiará el nombre.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectionDescriptor_GetName(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetDescriptionSize

Obtiene el tamaño del búfer necesario para almacenar la descripción.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
descriptionSize	[Salida] Tamaño del búfer para contener la descripción (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_GetDescriptionSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* descriptionSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetDescription

Obtiene la descripción de la protección.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
descriptionBuffer	[Salida] Búfer en el que se copiará la descripción.
descriptionBufferSize	Tamaño (en número de caracteres) de descriptionBuffer.
actualDescriptionSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si descriptionBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualDescriptionSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectionDescriptor_GetDescription(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* descriptionBuffer,
    const int64_t descriptionBufferSize,
    int64_t* actualDescriptionSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetTemplateId

Obtiene el identificador de plantilla.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
templateId	[Salida] Identificador de plantilla asociado a la protección
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_GetTemplateId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* templateId,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetLabelId

Obtiene el identificador de etiqueta.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
labelId	[Salida] Identificador de etiqueta asociado a la protección
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_GetLabelId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* labelId,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetContentId

Obtiene el identificador de contenido.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
contentId	[Salida] Identificador de contenido asociado a la protección
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_GetContentId(
    const mip_cc_protection_descriptor protectionDescriptor,
    mip_cc_guid* contentId,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_DoesContentExpire

Obtiene si el contenido tiene o no una hora de expiración o no.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
doesContentExpire	[Salida] Si expira o no el contenido
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_DoesContentExpire(
    const mip_cc_protection_descriptor protectionDescriptor,
    bool* doesContentExpire,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetContentValidUntil

Obtiene el tiempo de expiración de la protección (en segundos desde la época)

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
contentValidUntil	[Salida] Tiempo de expiración del contenido (en segundos desde la época)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_GetContentValidUntil(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* contentValidUntil,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess

Obtiene si se permite o no el acceso sin conexión.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
doesAllowOfflineAccess	[Salida] Si se permite o no el acceso sin conexión
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess(
    const mip_cc_protection_descriptor protectionDescriptor,
    bool* doesAllowOfflineAccess,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetReferrerSize

Obtiene el tamaño del búfer necesario para almacenar el remitente.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
referrerSize	[Salida] Tamaño del búfer para contener el origen de referencia (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectionDescriptor_GetReferrerSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* referrerSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetReferrer

Obtiene el origen de referencia de protección.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
referrerBuffer	[Salida] Búfer en el que se copiará el remitente.
referrerBufferSize	Tamaño (en número de caracteres) del objeto referrerBuffer.
actualReferrerSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si referrerBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realReferrerSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectionDescriptor_GetReferrer(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* referrerBuffer,
    const int64_t referrerBufferSize,
    int64_t* actualReferrerSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetDoubleKeyUrlSize

Obtiene el tamaño del búfer necesario para almacenar la dirección URL de doble clave.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
url	[Salida] Tamaño del búfer para contener la dirección URL de la clave doble (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectionDescriptor_GetDoubleKeyUrlSize(
    const mip_cc_protection_descriptor protectionDescriptor,
    int64_t* urlSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl

Obtiene la dirección URL de la clave doble.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
urlBuffer	[Salida] Almacenar en búfer en el que se copiará la dirección URL.
urlBufferSize	Tamaño (en número de caracteres) del urlBuffer.
actualUrlSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si urlBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualUrlSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl(
    const mip_cc_protection_descriptor protectionDescriptor,
    char* urlBuffer,
    const int64_t urlBufferSize,
    int64_t* actualUrlSize,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseProtectionDescriptor

Liberar recursos asociados a un descriptor de protección

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor de protección que se va a liberar

void MIP_CC_ReleaseProtectionDescriptor(mip_cc_protection_descriptor protectionDescriptor);

MIP_CC_CreateStringList

Crear una lista de cadenas

Parámetros

Parámetro	Descripción
cadenas	Matriz de cadenas
count	Número de cadenas
stringList	[Salida] Lista de cadenas recién creada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Se debe liberar un mip_cc_string_list llamando a MIP_CC_ReleaseStringList

mip_cc_result MIP_CC_CreateStringList(
    const char** strings,
    const int64_t count,
    mip_cc_string_list* stringList,
    mip_cc_error* errorInfo);

MIP_CC_StringList_GetStrings

Obtener cadenas que componen una lista de cadenas

Parámetros

Parámetro	Descripción
stringList	Lista de cadenas de origen
cadenas	[Salida] Matriz de cadenas, memoria propiedad de mip_cc_string_list objeto
count	[Salida] Número de cadenas
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: La memoria de 'cadenas' es propiedad del objeto mip_cc_string_list, por lo que no debe liberarse de forma independiente.

mip_cc_result MIP_CC_StringList_GetStrings(
    const mip_cc_string_list stringList,
    const char*** strings,
    int64_t* count,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseStringList

Liberar recursos asociados a una lista de cadenas

Parámetros

Parámetro	Descripción
stringList	Lista de cadenas que se va a publicar

void MIP_CC_ReleaseStringList(mip_cc_string_list stringList);

mip_cc_dispatch_task_callback_fn

Definición de función de devolución de llamada para enviar una tarea asincrónica

Parámetros

Parámetro	Descripción
taskId	Identificador de tarea único

MIP_CC_CALLBACK(mip_cc_dispatch_task_callback_fn,
    void,
    const mip_cc_async_task*);

mip_cc_cancel_task_callback_fn

Función de devolución de llamada para cancelar tareas en segundo plano

Parámetros

Parámetro	Descripción
taskId	Identificador de tarea único

Return: True si la tarea se canceló correctamente; de lo contrario, false

MIP_CC_CALLBACK(mip_cc_cancel_task_callback_fn,
    bool,
    const char*);

MIP_CC_CreateTaskDispatcherDelegate

Crea un delegado de distribuidor de tareas que se puede usar para invalidar el control de tareas asincrónico predeterminado de MIP.

Parámetros

Parámetro	Descripción
dispatchTaskCallback	Puntero de función para enviar tareas asincrónicas
cancelTaskCallback	Puntero de función para cancelar tareas en segundo plano
cancelAllTasksCallback	Puntero de función para cancelar todas las tareas en segundo plano
taskDispatcher	[Salida] Identificador del objeto delegado del distribuidor de tareas
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_CreateTaskDispatcherDelegate(
    const mip_cc_dispatch_task_callback_fn dispatchTaskCallback,
    const mip_cc_cancel_task_callback_fn cancelTaskCallback,
    const mip_cc_cancel_all_tasks_callback_fn cancelAllTasksCallback,
    mip_cc_task_dispatcher_delegate* taskDispatcher,
    mip_cc_error* errorInfo);

MIP_CC_ExecuteDispatchedTask

Notifica a un delegado TaskDispatcher que una tarea está programada para ejecutarse ahora en el subproceso actual.

Parámetros

Parámetro	Descripción
taskDispatcher	Identificador del objeto delegado del distribuidor de tareas
taskId	Identificador de la tarea asincrónica asociada a esta operación

Nota: La aplicación debe llamar a esta función cuando se programa una tarea para ejecutarse. Dará como resultado la ejecución inmediata de la tarea en el subproceso actual. El identificador debe coincidir con el de una tarea no cancelada enviada previamente.

void MIP_CC_ExecuteDispatchedTask(const mip_cc_task_dispatcher_delegate taskDispatcher, const char* taskId);

MIP_CC_ReleaseTaskDispatcherDelegate

Liberar recursos asociados a un identificador delegado del distribuidor de tareas

Parámetros

Parámetro	Descripción
taskDispatcher	Delegado del distribuidor de tareas que se va a liberar

void MIP_CC_ReleaseTaskDispatcherDelegate(mip_cc_task_dispatcher_delegate taskDispatcher);

MIP_CC_CreateTelemetryConfiguration

Creación de un objeto de configuración usado para crear un perfil de protección

Parámetros

Parámetro	Descripción
telemetryConfig	[Salida] Instancia de configuración de telemetría recién creada que contiene la configuración predeterminada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_CreateTelemetryConfiguration(
    mip_cc_telemetry_configuration* telemetryConfig,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetHostName

Establecimiento de un nombre de host de telemetría que invalidará la configuración de telemetría interna

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
hostName	Nombre de host
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Esta propiedad se establece cuando una aplicación cliente usa el mismo componente de telemetría de Aria/1DS y desea que se use la configuración de telemetría interna (almacenamiento en caché, registro, prioridad, etc.) en lugar de la configuración predeterminada de MIP.

mip_cc_result MIP_CC_TelemetryConfiguration_SetHostName(
    const mip_cc_telemetry_configuration telemetryConfig,
    const char* hostName,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetLibraryName

Establecimiento de una invalidación de biblioteca compartida de telemetría

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
libraryName	Nombre del archivo DLL que implementa la API de C del SDK de Aria/1DS
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Esta propiedad se establece cuando un cliente tiene un archivo DLL de telemetría existente que implementa la API de C del SDK de Aria/1DS que se debe usar en lugar de mip_ClientTelemetry.dll

mip_cc_result MIP_CC_TelemetryConfiguration_SetLibraryName(
    const mip_cc_telemetry_configuration telemetryConfig,
    const char* libraryName,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetHttpDelegate

Invalidación de la pila HTTP de telemetría predeterminada con el propio cliente

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
httpDelegate	Instancia de devolución de llamada HTTP implementada por la aplicación cliente
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si no se establece esta propiedad, el componente de telemetría usará la pila HTTP predeterminada de MIP.

mip_cc_result MIP_CC_TelemetryConfiguration_SetHttpDelegate(
    const mip_cc_telemetry_configuration telemetryConfig,
    const mip_cc_http_delegate httpDelegate,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetTaskDispatcherDelegate

Invalidación del distribuidor de tareas asincrónico predeterminado con el propio cliente

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
taskDispatcherDelegate	Instancia de devolución de llamada del distribuidor de tareas implementada por la aplicación cliente
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_TelemetryConfiguration_SetTaskDispatcherDelegate(
    const mip_cc_telemetry_configuration telemetryConfig,
    const mip_cc_task_dispatcher_delegate taskDispatcherDelegate,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetIsNetworkDetectionEnabled

Establece si se permite o no que el componente de telemetría haga ping al estado de red en un subproceso en segundo plano.

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
isCachingEnabled	Indica si se permite o no que el componente de telemetría haga ping al estado de red en un subproceso en segundo plano.
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El valor predeterminado es "true"

mip_cc_result MIP_CC_TelemetryConfiguration_SetIsNetworkDetectionEnabled(
    const mip_cc_telemetry_configuration telemetryConfig,
    const bool isNetworkDetectionEnabled,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled

Establece si se permite o no que el componente de telemetría escriba memorias caché en el disco.

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
isCachingEnabled	Si se permite o no que el componente de telemetría escriba memorias caché en el disco.
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El valor predeterminado es "true"

mip_cc_result MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled(
    const mip_cc_telemetry_configuration telemetryConfig,
    const bool isCachingEnabled,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled

Establece si se permite o no que el componente de telemetría escriba registros en el disco.

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
isTraceLoggingEnabled	Si se permite o no que el componente de telemetría escriba registros en el disco.
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El valor predeterminado es "true"

mip_cc_result MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled(
    const mip_cc_telemetry_configuration telemetryConfig,
    const bool isTraceLoggingEnabled,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut

Establece si una aplicación o usuario ha optado por no participar en la telemetría opcional.

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
isTelemetryOptedOut	Si una aplicación o usuario ha optado por no participar en la telemetría opcional
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El valor predeterminado es "false"

mip_cc_result MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut(
    const mip_cc_telemetry_configuration telemetryConfig,
    const bool isTelemetryOptedOut,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_SetCustomSettings

Establece la configuración de telemetría personalizada

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
customSettings	Configuración de telemetría personalizada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_TelemetryConfiguration_SetCustomSettings(
    const mip_cc_telemetry_configuration telemetryConfig,
    const mip_cc_dictionary customSettings,
    mip_cc_error* errorInfo);

MIP_CC_TelemetryConfiguration_AddMaskedProperty

Establece una propiedad de telemetría para enmascarar

Parámetros

Parámetro	Descripción
telemetryConfig	Configuración de telemetría
eventName	Nombre del evento
propertyName	Nombre de la propiedad
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_TelemetryConfiguration_AddMaskedProperty(
    const mip_cc_telemetry_configuration telemetryConfig,
    const char* eventName,
    const char* propertyName,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseTelemetryConfiguration

Liberar recursos asociados a una configuración de perfil de protección

Parámetros

Parámetro	Descripción
profileSettings	Configuración del perfil de protección que se va a publicar

void MIP_CC_ReleaseTelemetryConfiguration(mip_cc_telemetry_configuration telemetryConfig);

MIP_CC_TemplateDescriptor_GetId

Obtiene el identificador de plantilla.

Parámetros

Parámetro	Descripción
protectionDescriptor	Descriptor asociado al contenido protegido
templateId	[Salida] Identificador de plantilla asociado a la protección
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_TemplateDescriptor_GetId(
    const mip_cc_template_descriptor protectionDescriptor,
    mip_cc_guid* templateId,
    mip_cc_error* errorInfo);

MIP_CC_TemplateDescriptor_GetNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre.

Parámetros

Parámetro	Descripción
templateDescriptor	Descriptor asociado a la plantilla
nameSize	[Salida] Tamaño del búfer que se va a contener (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_TemplateDescriptor_GetNameSize(
    const mip_cc_template_descriptor templateDescriptor,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_TemplateDescriptor_GetName

Obtiene el nombre de la plantilla.

Parámetros

Parámetro	Descripción
templateDescriptor	Descriptor asociado a la plantilla
nameBuffer	[Salida] Búfer en el que se copiará el nombre.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si NameBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_TemplateDescriptor_GetName(
    const mip_cc_template_descriptor templateDescriptor,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_TemplateDescriptor_GetDescriptionSize

Obtiene el tamaño del búfer necesario para almacenar la descripción.

Parámetros

Parámetro	Descripción
templateDescriptor	Descriptor asociado a la plantilla
descriptionSize	[Salida] Tamaño del búfer que se va a contener la descripción (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_TemplateDescriptor_GetDescriptionSize(
    const mip_cc_template_descriptor templateDescriptor,
    int64_t* descriptionSize,
    mip_cc_error* errorInfo);

MIP_CC_TemplateDescriptor_GetDescription

Obtiene la descripción de la plantilla.

Parámetros

Parámetro	Descripción
templateDescriptor	Descriptor asociado a la plantilla
descriptionBuffer	[Salida] Búfer en el que se copiará la descripción.
descriptionBufferSize	Tamaño (en número de caracteres) de descriptionBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si descriptionBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualDescriptionSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_TemplateDescriptor_GetDescription(
    const mip_cc_template_descriptor templateDescriptor,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseTemplateDescriptor

Liberar recursos asociados a un descriptor de plantilla

Parámetros

Parámetro	Descripción
templateDescriptor	Descriptor de plantilla que se va a liberar

void MIP_CC_ReleaseTemplateDescriptor(mip_cc_template_descriptor templateDescriptor);

MIP_CC_ActionResult_GetActions

Obtención de acciones que componen un resultado de acción

Parámetros

Parámetro	Descripción
actionResult	Resultado de la acción de origen
actions	[Salida] Matriz de acciones, memoria propiedad de mip_cc_action_result objeto
count	[Salida] Número de pares clave-valor
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: La memoria de 'actions' es propiedad del objeto mip_cc_action_result, por lo que no debe liberarse de forma independiente.

mip_cc_result MIP_CC_ActionResult_GetActions(
    const mip_cc_action_result actionResult,
    mip_cc_action** actions,
    int64_t* count,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseActionResult

Liberar recursos asociados a un resultado de acción

Parámetros

Parámetro	Descripción
actionResult	Resultado de la acción que se va a liberar

void MIP_CC_ReleaseActionResult(mip_cc_action_result actionResult);

MIP_CC_AddContentFooterAction_GetUIElementNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre del elemento de interfaz de usuario de la acción "Agregar pie de página de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
nameSize	[Salida] Tamaño del búfer para contener el nombre del elemento de la interfaz de usuario (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentFooterAction_GetUIElementNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetUIElementName

Obtiene el nombre del elemento de interfaz de usuario de la acción "agregar pie de página de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
nameBuffer	[Salida] Almacenar el búfer en el que se copiará el nombre del elemento de la interfaz de usuario.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentFooterAction_GetUIElementName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetTextSize

Obtiene el tamaño del búfer necesario para almacenar el texto de la acción "Agregar pie de página de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
nameSize	[Salida] Tamaño del búfer para contener texto (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentFooterAction_GetTextSize(
    const mip_cc_action action,
    int64_t* textSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetText

Obtiene el texto de la acción "Agregar pie de página de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
textBuffer	[Salida] Almacenar el búfer en el que se copiará el texto.
textBufferSize	Tamaño (en número de caracteres) del textBuffer.
actualTextSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si textBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realTextSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentFooterAction_GetText(
    const mip_cc_action action,
    char* textBuffer,
    const int64_t textBufferSize,
    int64_t* actualTextSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetFontNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre de fuente de la acción "Agregar pie de página de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
nameSize	[Salida] Tamaño del búfer para contener el nombre de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentFooterAction_GetFontNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetFontName

Obtiene el nombre de fuente de la acción "Agregar pie de página de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
nameBuffer	[Salida] Almacenar el búfer en el que se copiará el nombre de fuente.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentFooterAction_GetFontName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetFontSize

Obtiene el tamaño de fuente entero.

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
Fontsize	[Salida] Tamaño de fuente
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentFooterAction_GetFontSize(
    const mip_cc_action action,
    int32_t* fontSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetFontColorSize

Obtiene el tamaño del búfer necesario para almacenar el color de fuente de una acción "agregar pie de página de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
colorSize	[Salida] Tamaño del búfer para contener el color de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentFooterAction_GetFontColorSize(
    const mip_cc_action action,
    int64_t* colorSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetFontColor

Obtiene el color de fuente de una acción "agregar pie de página de contenido" (por ejemplo, "#0000000")

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
colorBuffer	[Salida] Búfer en el que se copiará el color de fuente.
colorBufferSize	Tamaño (en número de caracteres) del colorBuffer.
actualColorSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si colorBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realColorSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentFooterAction_GetFontColor(
    const mip_cc_action action,
    char* colorBuffer,
    const int64_t colorBufferSize,
    int64_t* actualColorSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetAlignment

Obtiene la alineación.

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
alineación	[Salida] Alineación
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddContentFooterAction_GetAlignment(
    const mip_cc_action action,
    mip_cc_content_mark_alignment* alignment,
    mip_cc_error* errorInfo);

MIP_CC_AddContentFooterAction_GetMargin

Obtiene el tamaño del margen.

Parámetros

Parámetro	Descripción
action	Acción "agregar pie de página de contenido"
marginSize	[Salida] Tamaño del margen (en mm)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddContentFooterAction_GetMargin(
    const mip_cc_action action,
    int32_t* marginSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetUIElementNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre del elemento de interfaz de usuario de la acción "Agregar encabezado de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
nameSize	[Salida] Tamaño del búfer para contener el nombre del elemento de la interfaz de usuario (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddContentHeaderAction_GetUIElementNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetUIElementName

Obtiene el nombre del elemento de interfaz de usuario de la acción "Agregar encabezado de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
nameBuffer	[Salida] Almacenar en búfer el nombre del elemento de la interfaz de usuario se copiará en.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si nameBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentHeaderAction_GetUIElementName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetTextSize

Obtiene el tamaño del búfer necesario para almacenar el texto de una acción "Agregar encabezado de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
nameSize	[Salida] Tamaño del búfer que se va a contener texto (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddContentHeaderAction_GetTextSize(
    const mip_cc_action action,
    int64_t* textSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetText

Obtiene el texto de una acción "agregar encabezado de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
textBuffer	[Salida] Búfer en el que se copiará el texto.
textBufferSize	Tamaño (en número de caracteres) del textBuffer.
actualTextSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si textBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualTextSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentHeaderAction_GetText(
    const mip_cc_action action,
    char* textBuffer,
    const int64_t textBufferSize,
    int64_t* actualTextSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetFontNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre de fuente de una acción de "agregar encabezado de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
nameSize	[Salida] Tamaño del búfer para contener el nombre de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentHeaderAction_GetFontNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetFontName

Obtiene el nombre de fuente de la acción "Agregar encabezado de contenido"

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
nameBuffer	[Salida] Almacenar el búfer en el que se copiará el nombre de fuente.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentHeaderAction_GetFontName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetFontSize

Obtiene el tamaño de fuente entero.

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
Fontsize	[Salida] Tamaño de fuente
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentHeaderAction_GetFontSize(
    const mip_cc_action action,
    int32_t* fontSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetFontColorSize

Obtiene el tamaño del búfer necesario para almacenar el color de fuente de una acción de "agregar encabezado de contenido".

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
colorSize	[Salida] Tamaño del búfer para contener el color de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentHeaderAction_GetFontColorSize(
    const mip_cc_action action,
    int64_t* colorSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetFontColor

Obtiene el color de fuente de la acción "Agregar encabezado de contenido" (por ejemplo, "#000000").

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
colorBuffer	[Salida] Almacenar en búfer el color de fuente en el que se copiará.
colorBufferSize	Tamaño (en número de caracteres) del colorBuffer.
actualColorSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si colorBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realColorSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddContentHeaderAction_GetFontColor(
    const mip_cc_action action,
    char* colorBuffer,
    const int64_t colorBufferSize,
    int64_t* actualColorSize,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetAlignment

Obtiene la alineación.

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
alineación	[Salida] Alineación
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentHeaderAction_GetAlignment(
    const mip_cc_action action,
    mip_cc_content_mark_alignment* alignment,
    mip_cc_error* errorInfo);

MIP_CC_AddContentHeaderAction_GetMargin

Obtiene el tamaño del margen.

Parámetros

Parámetro	Descripción
action	Acción "agregar encabezado de contenido"
marginSize	[Salida] Tamaño del margen (en mm)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddContentHeaderAction_GetMargin(
    const mip_cc_action action,
    int32_t* marginSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetUIElementNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre del elemento de interfaz de usuario de la acción "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
nameSize	[Salida] Tamaño del búfer para contener el nombre del elemento de la interfaz de usuario (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddWatermarkAction_GetUIElementNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetUIElementName

Obtiene el nombre del elemento de interfaz de usuario de la acción "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
nameBuffer	[Salida] Almacenar el búfer en el que se copiará el nombre del elemento de la interfaz de usuario.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddWatermarkAction_GetUIElementName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetLayout

Obtiene el diseño de la marca de agua.

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
diseño	[Salida] Diseño de marca de agua
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddWatermarkAction_GetLayout(
    const mip_cc_action action,
    mip_cc_watermark_layout* layout,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetTextSize

Obtiene el tamaño del búfer necesario para almacenar el texto de una acción de "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
textSize	[Salida] Tamaño del búfer para contener texto (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddWatermarkAction_GetTextSize(
    const mip_cc_action action,
    int64_t* textSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetText

Obtiene el texto de una acción "agregar marca de agua"

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
textBuffer	[Salida] Almacenar el búfer en el que se copiará el texto.
textBufferSize	Tamaño (en número de caracteres) del textBuffer.
actualTextSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si textBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realTextSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddWatermarkAction_GetText(
    const mip_cc_action action,
    char* textBuffer,
    const int64_t textBufferSize,
    int64_t* actualTextSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetFontNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre de fuente de una acción "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
nameSize	[Salida] Tamaño del búfer para contener el nombre de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_AddWatermarkAction_GetFontNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetFontName

Obtiene el nombre de fuente de una acción de "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
nameBuffer	[Salida] Almacenar el búfer en el que se copiará el nombre de fuente.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddWatermarkAction_GetFontName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetFontSize

Obtiene el tamaño de fuente entero.

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
Fontsize	[Salida] Tamaño de fuente
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddWatermarkAction_GetFontSize(
    const mip_cc_action action,
    int32_t* fontSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetFontColorSize

Obtiene el tamaño del búfer necesario para almacenar el color de fuente de una acción de "agregar marca de agua".

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
colorSize	[Salida] Tamaño del búfer para contener el color de fuente (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_AddWatermarkAction_GetFontColorSize(
    const mip_cc_action action,
    int64_t* colorSize,
    mip_cc_error* errorInfo);

MIP_CC_AddWatermarkAction_GetFontColor

Obtiene el color de fuente de una acción "agregar marca de agua" (por ejemplo, "#000000")

Parámetros

Parámetro	Descripción
action	Acción "agregar marca de agua"
colorBuffer	[Salida] Búfer en el que se copiará el color de fuente.
colorBufferSize	Tamaño (en número de caracteres) del colorBuffer.
actualColorSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si colorBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realColorSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_AddWatermarkAction_GetFontColor(
    const mip_cc_action action,
    char* colorBuffer,
    const int64_t colorBufferSize,
    int64_t* actualColorSize,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseContentLabel

Liberar recursos asociados a una etiqueta de contenido

Parámetros

Parámetro	Descripción
contentLabel	Etiqueta que se va a liberar

void MIP_CC_ReleaseContentLabel(mip_cc_content_label contentLabel);

MIP_CC_ContentLabel_GetCreationTime

Obtiene la hora en que se aplicó la etiqueta.

Parámetros

Parámetro	Descripción
contentLabel	Etiqueta
creationTime	[Salida] Hora en que se aplicó la etiqueta al documento (en segundos desde la época)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ContentLabel_GetCreationTime(
    const mip_cc_content_label contentLabel,
    int64_t* creationTime,
    mip_cc_error* errorInfo);

MIP_CC_ContentLabel_GetAssignmentMethod

Obtiene el método de asignación de etiquetas.

Parámetros

Parámetro	Descripción
contentLabel	Etiqueta
assignmentMethod	[Salida] Método de asignación (por ejemplo, "estándar" o "con privilegios")
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ContentLabel_GetAssignmentMethod(
    const mip_cc_content_label contentLabel,
    mip_cc_label_assignment_method* assignmentMethod,
    mip_cc_error* errorInfo);

MIP_CC_ContentLabel_GetExtendedProperties

Obtiene propiedades extendidas.

Parámetros

Parámetro	Descripción
contentLabel	Etiqueta
properties	[Salida] Diccionario de propiedades extendidas, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: El autor de la llamada debe liberar la variable "properties" llamando a MIP_CC_ReleaseDictionary

mip_cc_result MIP_CC_ContentLabel_GetExtendedProperties(
    const mip_cc_content_label contentLabel,
    mip_cc_metadata_dictionary* properties,
    mip_cc_error* errorInfo);

MIP_CC_ContentLabel_IsProtectionAppliedFromLabel

Obtiene si una etiqueta aplicó o no una protección.

Parámetros

Parámetro	Descripción
contentLabel	Etiqueta
isProtectionAppliedByLabel	[Salida] Si el documento está protegido y esta etiqueta aplica explícitamente la protección.
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_ContentLabel_IsProtectionAppliedFromLabel(
    const mip_cc_content_label contentLabel,
    bool* isProtectionAppliedByLabel,
    mip_cc_error* errorInfo);

MIP_CC_ContentLabel_GetLabel

Obtiene las propiedades de etiqueta genérica de una instancia de etiqueta de contenido.

Parámetros

Parámetro	Descripción
contentLabel	Label
label	[Salida] Etiqueta genérica, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El autor de la llamada debe liberar la variable 'label' llamando a MIP_CC_ReleaseLabel

mip_cc_result MIP_CC_ContentLabel_GetLabel(
    const mip_cc_content_label contentLabel,
    mip_cc_label* label,
    mip_cc_error* errorInfo);

MIP_CC_CustomAction_GetNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre de una acción "personalizada".

Parámetros

Parámetro	Descripción
action	Acción "personalizada"
nameSize	[Salida] Tamaño del búfer para contener el nombre (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_CustomAction_GetNameSize(
    const mip_cc_action action,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_CustomAction_GetName

Obtiene el nombre de una acción "personalizada".

Parámetros

Parámetro	Descripción
action	Acción "personalizada"
nameBuffer	[Salida] Búfer en el que se copiará el nombre.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_CustomAction_GetName(
    const mip_cc_action action,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_CustomAction_GetProperties

Obtiene las propiedades de una acción "personalizada".

Parámetros

Parámetro	Descripción
action	Acción "personalizada"
properties	[Salida] Diccionario de propiedades, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El autor de la llamada debe liberar la variable 'properties' llamando a MIP_CC_ReleaseDictionary

mip_cc_result MIP_CC_CustomAction_GetProperties(
    const mip_cc_action action,
    mip_cc_dictionary* properties,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseLabel

Liberar recursos asociados a una etiqueta

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta que se va a liberar

void MIP_CC_ReleaseLabel(mip_cc_label label);

MIP_CC_Label_GetId

Obtiene el identificador de etiqueta.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
labelId	[Salida] Id. de etiqueta
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetId(
    const mip_cc_label label,
    mip_cc_guid* labelId,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetNameSize

Obtiene el tamaño del búfer necesario para almacenar el nombre.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
nameSize	[Salida] Tamaño del búfer para contener el nombre (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetNameSize(
    const mip_cc_label label,
    int64_t* nameSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetName

Obtiene el nombre de la etiqueta.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
nameBuffer	[Salida] Búfer en el que se copiará el nombre.
nameBufferSize	Tamaño (en número de caracteres) del nameBuffer.
actualNameSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si nameBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualNameSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetName(
    const mip_cc_label label,
    char* nameBuffer,
    const int64_t nameBufferSize,
    int64_t* actualNameSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetDescriptionSize

Obtiene el tamaño del búfer necesario para almacenar la descripción.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
descriptionSize	[Salida] Tamaño del búfer para contener la descripción (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetDescriptionSize(
    const mip_cc_label label,
    int64_t* descriptionSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetDescription

Obtiene la descripción de la etiqueta.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
descriptionBuffer	[Salida] Almacenar el búfer en el que se copiará la descripción.
descriptionBufferSize	Tamaño (en número de caracteres) del descriptionBuffer.
actualDescriptionSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si descriptionBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realDescriptionSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetDescription(
    const mip_cc_label label,
    char* descriptionBuffer,
    const int64_t descriptionBufferSize,
    int64_t* actualDescriptionSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetColorSize

Obtiene el tamaño del búfer necesario para almacenar el color.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
colorSize	[Salida] Tamaño del búfer para contener el color (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetColorSize(
    const mip_cc_label label,
    int64_t* colorSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetColor

Obtiene el color de la etiqueta.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
colorBuffer	[Salida] Almacenar en búfer el color se copiará en (en formato #RRGGBB).
colorBufferSize	Tamaño (en número de caracteres) del colorBuffer.
actualColorSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si colorBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realColorSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetColor(
    const mip_cc_label label,
    char* colorBuffer,
    const int64_t colorBufferSize,
    int64_t* actualColorSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetSensitivity

Obtiene el nivel de confidencialidad de la etiqueta. Un valor mayor significa más confidencial.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
sensitivity	[Salida] Nivel de confidencialidad
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetSensitivity(
    const mip_cc_label label,
    int32_t* sensitivity,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetTooltipSize

Obtiene el tamaño del búfer necesario para almacenar la información sobre herramientas.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
tooltipSize	[Salida] Tamaño del búfer para contener información sobre herramientas (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetTooltipSize(
    const mip_cc_label label,
    int64_t* tooltipSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetTooltip

Obtiene la información sobre herramientas de etiquetas.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
tooltipBuffer	[Salida] Búfer en el que se copiará la información sobre herramientas.
tooltipBufferSize	Tamaño (en número de caracteres) del tooltipBuffer.
actualTooltipSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si tooltipBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualTooltipSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetTooltip(
    const mip_cc_label label,
    char* tooltipBuffer,
    const int64_t tooltipBufferSize,
    int64_t* actualTooltipSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetAutoTooltipSize

Obtiene el tamaño del búfer necesario para almacenar la información sobre herramientas de clasificación automática.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
tooltipSize	[Salida] Tamaño del búfer para contener información sobre herramientas (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetAutoTooltipSize(
    const mip_cc_label label,
    int64_t* tooltipSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetAutoTooltip

Obtiene la información sobre herramientas de clasificación automática de etiquetas.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
tooltipBuffer	[Salida] Búfer en el que se copiará la información sobre herramientas.
tooltipBufferSize	Tamaño (en número de caracteres) del tooltipBuffer.
actualTooltipSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si tooltipBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualTooltipSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetAutoTooltip(
    const mip_cc_label label,
    char* tooltipBuffer,
    const int64_t tooltipBufferSize,
    int64_t* actualTooltipSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_IsActive

Obtiene si una etiqueta está activa o no.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
isActive	[Salida] Si una etiqueta se considera activa o no.
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Solo se pueden aplicar etiquetas activas. Las etiquetas de desactivación no se pueden aplicar y solo se usan con fines de visualización.

mip_cc_result MIP_CC_Label_IsActive(
    const mip_cc_label label,
    bool* isActive,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetParent

Obtiene la etiqueta primaria, si existe.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
primario	[Salida] Etiqueta primaria, si existe, null
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetParent(
    const mip_cc_label label,
    mip_cc_label* parent,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetChildrenSize

Obtiene el número de etiquetas secundarias.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
Niñostamaño	[Salida] Número de elementos secundarios
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_Label_GetChildrenSize(
    const mip_cc_label label,
    int64_t* childrenSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetChildren

Obtiene las etiquetas secundarias.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
childrenBuffer	[Salida] Almacenar en búfer las etiquetas secundarias en las que se copiarán. Etiquetas secundarias
childrenBufferSize	Tamaño (en número de etiquetas) del elemento childrenBuffer.
realChildrenSize	[Salida] Número de etiquetas secundarias escritas en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si childrenBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y realChildrenSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_Label_GetChildren(
    const mip_cc_label label,
    mip_cc_label* childrenBuffer,
    const int64_t childrenBufferSize,
    int64_t* actualChildrenSize,
    mip_cc_error* errorInfo);

MIP_CC_Label_GetCustomSettings

Obtiene la configuración personalizada definida por directivas de una etiqueta.

Parámetros

Parámetro	Descripción
etiqueta	Etiqueta
configuración	[Salida] Diccionario de configuraciones, propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El autor de la llamada debe liberar la variable "settings" llamando a MIP_CC_ReleaseDictionary

mip_cc_result MIP_CC_Label_GetCustomSettings(
    const mip_cc_label label,
    mip_cc_dictionary* settings,
    mip_cc_error* errorInfo);

MIP_CC_MetadataAction_GetMetadataToRemove

Obtiene los metadatos de una acción de "metadatos" que se van a quitar.

Parámetros

Parámetro	Descripción
action	Acción "metadatos"
metadataNames	[Salida] Nombres clave de metadatos que se van a quitar, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: El autor de la llamada debe liberar la variable "metadataNames" llamando a MIP_CC_ReleaseStringList @note Se deben realizar los metadatos quitando metadatos antes de agregar metadatos.

mip_cc_result MIP_CC_MetadataAction_GetMetadataToRemove(
    const mip_cc_action action,
    mip_cc_string_list* metadataNames,
    mip_cc_error* errorInfo);

MIP_CC_MetadataAction_GetMetadataToAdd

Obtiene los metadatos de una acción de "metadatos" que se van a agregar.

Parámetros

Parámetro	Descripción
action	Acción "metadatos"
metadata	[Salida] lista de entradas de metadatos que se van a agregar, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: El autor de la llamada debe liberar la variable "metadata" llamando a MIP_CC_ReleaseDictionary @note Se deben realizar las tareas de eliminación de metadatos antes de agregar metadatos.

mip_cc_result MIP_CC_MetadataAction_GetMetadataToAdd(
    const mip_cc_action action,
    mip_cc_metadata_dictionary* metadata,
    mip_cc_error* errorInfo);

MIP_CC_CreateMetadataDictionary

Creación de un diccionario de claves y valores de cadena

Parámetros

Parámetro	Descripción
entries	Matriz de entradas de metadatos
count	Número de entradas de metadatos
diccionario	[Salida] Diccionario recién creado
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Se debe liberar un mip_cc_dictionary llamando a MIP_CC_ReleaseDictionary

mip_cc_result MIP_CC_CreateMetadataDictionary(
    const mip_cc_metadata_entry* entries,
    const int64_t count,
    mip_cc_metadata_dictionary* dictionary,
    mip_cc_error* errorInfo);

MIP_CC_MetadataDictionary_GetEntries

Obtener entradas de metadatos que componen un diccionario

Parámetros

Parámetro	Descripción
diccionario	Diccionario de origen
entries	[Salida] Matriz de entradas de metadatos, memoria propiedad de mip_cc_dictionary objeto
count	[Salida] Número de entradas de metadatos
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: La memoria de "entradas" es propiedad del objeto mip_cc_dictionary, por lo que no debe liberarse de forma independiente.

mip_cc_result MIP_CC_MetadataDictionary_GetEntries(
    const mip_cc_metadata_dictionary dictionary,
    mip_cc_metadata_entry** entries,
    int64_t* count,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseMetadataDictionary

Liberar recursos asociados a un diccionario

Parámetros

Parámetro	Descripción
diccionario	Diccionario que se va a publicar

void MIP_CC_ReleaseMetadataDictionary(mip_cc_metadata_dictionary dictionary);

MIP_CC_ReleasePolicyHandler

Liberar recursos asociados a un controlador de directivas

Parámetros

Parámetro	Descripción
handler	Controlador de directivas que se va a liberar

void MIP_CC_ReleasePolicyHandler(mip_cc_policy_handler handler);

MIP_CC_PolicyHandler_GetSensitivityLabel

Obtiene la etiqueta actual de un documento.

Parámetros

Parámetro	Descripción
handler	Controlador de directivas
documentState	Estado del documento
context	Contexto de aplicación reenviado opacomente a las devoluciones de llamada
contentLabel	Etiqueta aplicada actualmente a un documento
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_PolicyHandler_GetSensitivityLabel(
    const mip_cc_policy_handler handler,
    const mip_cc_document_state* documentState,
    const void* context,
    mip_cc_content_label* contentLabel,
    mip_cc_error* errorInfo);

MIP_CC_PolicyHandler_ComputeActions

Ejecuta reglas de directiva basadas en el estado proporcionado y determina las acciones correspondientes.

Parámetros

Parámetro	Descripción
handler	Controlador de directivas
documentState	Estado del documento
applicationState	Estado de acción de la aplicación
context	Contexto de aplicación reenviado opacomente a las devoluciones de llamada
actionResult	[Salida] Acciones que debe realizar la aplicación, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: El autor de la llamada debe liberar la variable "actionResult" llamando a MIP_CC_ReleaseActionResult

mip_cc_result MIP_CC_PolicyHandler_ComputeActions(
    const mip_cc_policy_handler handler,
    const mip_cc_document_state* documentState,
    const mip_cc_application_action_state* applicationState,
    const void* context,
    mip_cc_action_result* actionResult,
    mip_cc_error* errorInfo);

MIP_CC_PolicyHandler_NotifyCommittedActions

Llamada por aplicación después de que se hayan aplicado acciones calculadas y los datos confirmados en el disco

Parámetros

Parámetro	Descripción
handler	Controlador de directivas
documentState	Estado del documento
applicationState	Estado de acción de la aplicación
context	Contexto de aplicación reenviado opacamente a las devoluciones de llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Se necesita una llamada a esta función para transmitir datos de auditoría de etiquetas completos.

mip_cc_result MIP_CC_PolicyHandler_NotifyCommittedActions(
    const mip_cc_policy_handler handler,
    const mip_cc_document_state* documentState,
    const mip_cc_application_action_state* applicationState,
    const void* context,
    mip_cc_error* errorInfo);

MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrlSize

Obtiene el tamaño del búfer necesario para almacenar la dirección URL de cifrado de clave doble.

Parámetros

Parámetro	Descripción
action	Acción "proteger por directiva ad hoc con doble clave"
urlSize	[Salida] Tamaño del búfer para contener la dirección URL (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrlSize(
    const mip_cc_action action,
    int64_t* urlSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrl

Obtiene la dirección URL de cifrado de clave doble.

Parámetros

Parámetro	Descripción
action	Acción "proteger por directiva ad hoc con doble clave"
urlBuffer	[Salida] Almacenar en búfer en el que se copiará la dirección URL.
urlBufferSize	Tamaño (en número de caracteres) del urlBuffer.
actualUrlSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si urlBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualUrlSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrl(
    const mip_cc_action action,
    char* urlBuffer,
    const int64_t urlBufferSize,
    int64_t* actualUrlSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrlSize

Obtiene el tamaño del búfer necesario para almacenar la dirección URL de cifrado de clave doble.

Parámetros

Parámetro	Descripción
action	Acción "proteger por dp no reenviar directiva con doble clave"
urlSize	[Salida] Tamaño del búfer para contener la dirección URL (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

mip_cc_result MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrlSize(
    const mip_cc_action action,
    int64_t* urlSize,
    mip_cc_error* errorInfo);

MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrl

Obtiene la dirección URL de cifrado de clave doble.

Parámetros

Parámetro	Descripción
action	Acción "proteger por dp no reenviar directiva con doble clave"
urlBuffer	[Salida] Almacenar en búfer en el que se copiará la dirección URL.
urlBufferSize	Tamaño (en número de caracteres) del urlBuffer.
actualUrlSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: Si urlBuffer es nulo o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualUrlSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrl(
    const mip_cc_action action,
    char* urlBuffer,
    const int64_t urlBufferSize,
    int64_t* actualUrlSize,
    mip_cc_error* errorInfo);

MIP_CC_RemoveContentFooterAction_GetUIElementNames

Obtiene los nombres de elementos de la interfaz de usuario de la acción "Quitar pie de página de contenido" que se van a quitar.

Parámetros

Parámetro	Descripción
action	Acción "quitar pie de página de contenido"
nombres	[Salida] Nombres de elementos de la interfaz de usuario que se van a quitar, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El autor de la llamada debe liberar la variable "names" mediante una llamada a MIP_CC_ReleaseStringList

mip_cc_result MIP_CC_RemoveContentFooterAction_GetUIElementNames(
    const mip_cc_action action,
    mip_cc_string_list* names,
    mip_cc_error* errorInfo);

MIP_CC_RemoveContentHeaderAction_GetUIElementNames

Obtiene los nombres de elementos de la interfaz de usuario de la acción "quitar encabezado de contenido" para quitar.

Parámetros

Parámetro	Descripción
action	Acción "quitar encabezado de contenido"
nombres	[Salida] Nombres de elementos de la interfaz de usuario que se van a quitar, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica que se ha realizado correctamente o no.

Nota: El autor de la llamada debe liberar la variable "names" mediante una llamada a MIP_CC_ReleaseStringList

mip_cc_result MIP_CC_RemoveContentHeaderAction_GetUIElementNames(
    const mip_cc_action action,
    mip_cc_string_list* names,
    mip_cc_error* errorInfo);

MIP_CC_RemoveWatermarkAction_GetUIElementNames

Obtiene los nombres de elementos de la interfaz de usuario de una acción de "quitar marca de agua" para quitar.

Parámetros

Parámetro	Descripción
action	Acción "quitar pie de página de marca de agua"
nombres	[Salida] Nombres de elementos de interfaz de usuario que se van a quitar, memoria propiedad del autor de la llamada
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: El autor de la llamada debe liberar la variable "names" llamando a MIP_CC_ReleaseStringList

mip_cc_result MIP_CC_RemoveWatermarkAction_GetUIElementNames(
    const mip_cc_action action,
    mip_cc_string_list* names,
    mip_cc_error* errorInfo);

MIP_CC_ReleaseSensitivityType

Liberar recursos asociados a un tipo de confidencialidad

Parámetros

Parámetro	Descripción
sensitivityType	Tipo de confidencialidad que se va a liberar

void MIP_CC_ReleaseSensitivityType(mip_cc_sensitivity_type sensitivityType);

MIP_CC_SensitivityType_GetRulePackageIdSize

Obtiene el tamaño del búfer necesario para almacenar el identificador de paquete de reglas de un tipo de confidencialidad.

Parámetros

Parámetro	Descripción
sensitivityType	Tipo de confidencialidad
idSize	[Salida] Tamaño del búfer para contener el identificador del paquete de reglas (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_SensitivityType_GetRulePackageIdSize(
    const mip_cc_sensitivity_type sensitivityType,
    int64_t* idSize,
    mip_cc_error* errorInfo);

MIP_CC_SensitivityType_GetRulePackageId

Obtiene el identificador de paquete de reglas de un tipo de confidencialidad.

Parámetros

Parámetro	Descripción
sensitivityType	Tipo de confidencialidad
idBuffer	[Salida] Búfer en el que se copiará el identificador.
idBufferSize	Tamaño (en número de caracteres) del idBuffer.
actualIdSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si idBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualIdSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_SensitivityType_GetRulePackageId(
    const mip_cc_sensitivity_type sensitivityType,
    char* idBuffer,
    const int64_t idBufferSize,
    int64_t* actualIdSize,
    mip_cc_error* errorInfo);

MIP_CC_SensitivityType_GetRulePackageSize

Obtiene el tamaño del búfer necesario para almacenar el paquete de reglas de un tipo de confidencialidad.

Parámetros

Parámetro	Descripción
sensitivityType	Tipo de confidencialidad
rulePackageSize	[Salida] Tamaño del búfer para contener el paquete de reglas (en número de caracteres)
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

mip_cc_result MIP_CC_SensitivityType_GetRulePackageSize(
    const mip_cc_sensitivity_type sensitivityType,
    int64_t* rulePackageSize,
    mip_cc_error* errorInfo);

MIP_CC_SensitivityType_GetRulePackage

Obtiene el paquete de reglas de un tipo de confidencialidad.

Parámetros

Parámetro	Descripción
sensitivityType	Tipo de confidencialidad
rulePackageBuffer	[Salida] Búfer en el que se copiará el paquete de reglas.
rulePackageBufferSize	Tamaño (en número de caracteres) del rulePackageBuffer.
actualRulePackageSize	[Salida] Número de caracteres escritos en el búfer
errorInfo	[Salida] (Opcional) Información de error si el resultado de la operación es un error

Return: código de resultado que indica éxito o error

Nota: Si rulePackageBuffer es null o no es suficiente, se devolverá MIP_RESULT_ERROR_INSUFFICIENT_BUFFER y actualRulePackageSize se establecerá en el tamaño mínimo necesario del búfer.

mip_cc_result MIP_CC_SensitivityType_GetRulePackage(
    const mip_cc_sensitivity_type sensitivityType,
    char* rulePackageBuffer,
    const int64_t rulePackageBufferSize,
    int64_t* actualRulePackageSize,
    mip_cc_error* errorInfo);