Funciones

mip_cc_auth_callback

Definición de función de devolución de llamada para adquirir token de OAuth2

Parámetros

Parámetro Descripción
identidad La dirección de correo electrónico cuyo token se adquirirá
reto Reto de OAuth2
contexto Contexto de aplicación opaco que se ha pasado a la API de MIP que ha dado como resultado esta devolución de llamada de autenticación
tokenBuffer [Salida] Búfer en el que se copiará el token. Si es null, se rellenará "realTokenSize", pero
tokenBufferSize Tamaño (en bytes) del búfer de salida
actualTokenSize [Salida] Tamaño real (en bytes) del token

Retorno:Se ha recuperado true is token, 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*);

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 La 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

Crear un diccionario de claves o valores de cadena

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Una mip_cc_dictionary debe liberarse 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 de clave y valor que redactan un diccionario

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La memoria de las "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
solicitud La solicitud HTTP que debe realizar la aplicación
contexto El mismo contexto opaco pasado a la llamada de API de MIP que dio como resultado 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 El id. 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
cancelar devolución de llamada Puntero de función para cancelar solicitudes HTTP
httpDelegate [Salida] Controlador del objeto delegado HTTP
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 Controlador del objeto delegado HTTP
requestId Id. de solicitud HTTP asociada a esta operación
resultado Estado de funcionamiento correcto o fall
respuesta La respuesta HTTP si la operación se realiza correctamente, sino nullptr

Nota:La aplicación debe llamar a esta función cuando se haya completado una operación HTTP. El id. de la respuesta HTTP debe coincidir con el id. de la solicitud HTTP para permitir que MIP correlaciona 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 con un controlador 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 inicialización del registrador

Parámetros

Parámetro Descripción
storagePath Ruta de acceso de archivo en la que 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.
Mensaje el mensaje de la instrucción de registro.
función 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.
línea el 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 inicialización
flushCallback Puntero de función para vaciar registros
writeCallback Puntero de función para escribir una instrucción de registro
registradorDelegate [Salida] Controlador para el objeto delegado del registrador
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado é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 con un controlador de delegado de registrador

Parámetros

Parámetro Descripción
registradorDelegate Delegado de registrador que se va a publicar
void MIP_CC_ReleaseLoggerDelegate(mip_cc_logger_delegate loggerDelegate);

MIP_CC_CreateMipContext

Crear 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
ruta de acceso Ruta de acceso de archivo en la que se almacenan el registro, 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 de registrador
telemetríaOverride (Opcional) Se ha anulado 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

Retorno:Código de resultado que indica que se ha dado é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

Crear 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
ruta de acceso Ruta de acceso de archivo en la que se almacenan el registro, 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 de registrador
telemetríaOverride (Opcional) Se ha anulado 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 las invalidaciones de características personalizadas (en # 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 publicar
void MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext);

MIP_CC_ProtectionDescriptor_GetProtectionType

Obtiene tipo de protección, independientemente de si se define mediante una plantilla RMS o no

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor asociado con 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 con contenido protegido
ownerSize [Salida] Tamaño del búfer para mantener el propietario (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 con 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 con contenido protegido
nameSize [Salida] Tamaño del búfer para mantener el nombre (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 con contenido protegido
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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 con 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

Retorno:Código de resultado que indica que se ha dado é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 protección

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor asociado con contenido protegido
description Buffer [Salida] Almacenar en búfer la descripción se copiará en.
descriptionBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si descriptionBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualDescriptionSize se establecerá en el tamaño de búfer mínimo necesario.

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 id. de plantilla

Parámetros

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

Retorno:Código de resultado que indica que se ha dado é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 id. de etiqueta

Parámetros

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

Retorno:Código de resultado que indica que se ha dado é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 id. de contenido

Parámetros

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

Retorno:Código de resultado que indica que se ha dado é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 fecha de expiración o no

Parámetros

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

Retorno:Código de resultado que indica que se ha dado é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 la hora de expiración de la protección (en segundos desde la época)

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor asociado con 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

Retorno:Código de resultado que indica que se ha dado é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 con 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

Retorno:Código de resultado que indica que se ha dado é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 referente

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 un referente de protección

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor asociado con contenido protegido
referrerBuffer [Salida] El búfer en el que se copiará el referenciador.
referrerBufferSize Tamaño (en número de caracteres) del 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 clave doble

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 clave doble

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor asociado con contenido protegido
url Buffer [Salida] Almacenar en búfer la dirección URL se copiará en.
urlBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 con un descriptor de protección

Parámetros

Parámetro Descripción
protectionDescriptor Descriptor de protección que se va a publicar
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
contar Número de cadenas
stringList [Salida] Lista de cadenas recién creadas
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Una mip_cc_string_list debe liberarse 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 redacten 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
contar [Salida] Número de cadenas
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La memoria de las "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

Devolver:Verdadero si la tarea se canceló correctamente, de lo contrario, es falso.

MIP_CC_CALLBACK(mip_cc_cancel_task_callback_fn,
    bool,
    const char*);

MIP_CC_CreateTaskDispatcherDelegate

Crea un delegado de despachador de tareas que se puede usar para invalidar la administración de tareas asincrónicas predeterminada de MIP

Parámetros

Parámetro Descripción
dispatchTaskCallback Puntero de función para distribuir 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] Controlar el objeto delegado del despachador de tareas
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de TaskDispatcher que una tarea está programada para ejecutarse ahora en el hilo actual

Parámetros

Parámetro Descripción
taskDispatcher Controlar el objeto delegado del despachador de tareas
taskId Id. de tarea asincrónica asociada a esta operación

Nota:La aplicación debe llamar a esta función cuando se programe la ejecución de una tarea. Esto dará como resultado la ejecución inmediata de la tarea en el hilo actual. El id. 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 con un controlador delegado de despachador de tareas

Parámetros

Parámetro Descripción
taskDispatcher Delegado del despachador de tareas que se va a publicar
void MIP_CC_ReleaseTaskDispatcherDelegate(mip_cc_task_dispatcher_delegate taskDispatcher);

MIP_CC_CreateTelemetryConfiguration

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

Parámetros

Parámetro Descripción
telemetríaConfig [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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

MIP_CC_TelemetryConfiguration_SetHostName

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

Parámetros

Parámetro Descripción
telemetríaConfig 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Esta propiedad se establece cuando una aplicación cliente usa el mismo componente de telemetría Aria/1DS y desea su configuración de telemetría interna (almacenamiento en caché, registro, prioridad, etc.). para usarse 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

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

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Esta propiedad se establece cuando un cliente tiene una DLL de telemetría existente que implementa la API C del SDK de Aria/1DS que debe usarse 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

Invalidar la pila HTTP de telemetría predeterminada con la suya propia del cliente

Parámetros

Parámetro Descripción
telemetríaConfig 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si esta propiedad no está establecida, 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

Invalidar el despachador de tareas asincrónicas predeterminado con el propio cliente

Parámetros

Parámetro Descripción
telemetríaConfig 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una conversación en segundo plano

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El valor predeterminado es "verdadero"

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 cachés en el disco

Parámetros

Parámetro Descripción
telemetríaConfig Configuración de telemetría
isCachingEnabled Si el componente de telemetría está permitido o no escribir cachés en el disco
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El valor predeterminado es "verdadero"

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
telemetríaConfig Configuración de telemetría
isTraceLoggingEnabled Si el componente de telemetría está permitido o no escribir registros en el disco
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El valor predeterminado es "verdadero"

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 telemetría opcional

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El valor predeterminado es "falso"

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
telemetríaConfig 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 en máscara

Parámetros

Parámetro Descripción
telemetríaConfig 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de perfil de protección que se va a publicar
void MIP_CC_ReleaseTelemetryConfiguration(mip_cc_telemetry_configuration telemetryConfig);

MIP_CC_TemplateDescriptor_GetId

Obtiene id. de plantilla

Parámetros

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

Retorno:Código de resultado que indica que se ha dado é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 plantilla
nameSize [Salida] Tamaño del búfer para mantener el nombre (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado é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 plantilla
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si NameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualNameSize se establecerá en el tamaño de búfer mínimo necesario.

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 plantilla
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

Retorno:Código de resultado que indica que se ha dado é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 plantilla
description Buffer [Salida] Almacenar en búfer la descripción se copiará en.
descriptionBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si descriptionBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualDescriptionSize se establecerá en el tamaño de búfer mínimo necesario.

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 con un descriptor de plantilla

Parámetros

Parámetro Descripción
templateDescriptor Descriptor de plantilla que se va a publicar
void MIP_CC_ReleaseTemplateDescriptor(mip_cc_template_descriptor templateDescriptor);

MIP_CC_ActionResult_GetActions

Obtener acciones que redacten un resultado de acción

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La memoria de las "acciones" 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 con un resultado de acción

Parámetros

Parámetro Descripción
actionResult Resultado de la acción que se va a publicar
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 la interfaz de usuario de una acción de "agregar pie de página de contenido".

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar pie de página de contenido".

Parámetros

Parámetro Descripción
acción Acción "agregar pie de página de contenido"
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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 una acción de "agregar pie de página de contenido".

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar pie de página de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar pie de página de contenido"
textBuffer [Salida] Almacenar en búfer el texto se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si textBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualTextSize se establecerá en el tamaño de búfer mínimo necesario.

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 una acción de "agregar pie de página de contenido".

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar pie de página de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar pie de página de contenido"
name Buffer [Salida] Almacenar en búfer el nombre de fuente 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de "agregar pie de página de contenido".

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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, "#000000")

Parámetros

Parámetro Descripción
acción Acción "agregar pie de página de contenido"
colorBuffer [Salida] Almacenar en búfer el color de fuente se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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
acción 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

Retorno:Código de resultado que indica que se ha dado é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 de margen

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado é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 una acción de "agregar encabezado de contenido"

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado é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 una acción de "agregar encabezado de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar encabezado de contenido"
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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 de "agregar encabezado de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar encabezado 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

Retorno:Código de resultado que indica que se ha dado é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 de "agregar encabezado de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar encabezado de contenido"
textBuffer [Salida] Almacenar en búfer el texto se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si textBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualTextSize se establecerá en el tamaño de búfer mínimo necesario.

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar encabezado de contenido"

Parámetros

Parámetro Descripción
acción Acción "agregar encabezado de contenido"
name Buffer [Salida] Almacenar en búfer el nombre de fuente 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción "agregar encabezado de contenido" (por ejemplo, "#000000")

Parámetros

Parámetro Descripción
acción Acción "agregar encabezado de contenido"
colorBuffer [Salida] Almacenar en búfer el color de fuente se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de margen

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar marca de agua"

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 una acción de "agregar marca de agua"

Parámetros

Parámetro Descripción
acción Acción "agregar marca de agua"
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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 marca de agua

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de "agregar marca de agua"

Parámetros

Parámetro Descripción
acción Acción "agregar marca de agua"
textBuffer [Salida] Almacenar en búfer el texto se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si textBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualTextSize se establecerá en el tamaño de búfer mínimo necesario.

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 de "agregar marca de agua"

Parámetros

Parámetro Descripción
acción 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción Acción "agregar marca de agua"
name Buffer [Salida] Almacenar en búfer el nombre de fuente 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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
acción 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

Retorno:Código de resultado que indica que se ha dado é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
acción 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

Retorno:Código de resultado que indica que se ha dado é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 de "agregar marca de agua" (por ejemplo, "#000000")

Parámetros

Parámetro Descripción
acción Acción "agregar marca de agua"
colorBuffer [Salida] Almacenar en búfer el color de fuente se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 publicar
void MIP_CC_ReleaseContentLabel(mip_cc_content_label contentLabel);

MIP_CC_ContentLabel_GetCreationTime

Obtiene tiempo cuando se aplicó la etiqueta

Parámetros

Parámetro Descripción
contentLabel Etiqueta
creationTime [Salida] Hora en la 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

Retorno:Código de resultado que indica que se ha dado é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 "privilegiado")
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado é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
propiedades [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "propiedades" 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 aplicó explícitamente la protección.
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado é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 propiedades de etiqueta genéricas de una instancia de etiqueta de contenido

Parámetros

Parámetro Descripción
contentLabel Etiqueta
etiqueta [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "etiqueta" 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
acción Acción "personalizada"
nameSize [Salida] Tamaño del búfer para mantener el nombre (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción Acción "personalizada"
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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
acción Acción "personalizada"
propiedades [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "propiedades" 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 publicar
void MIP_CC_ReleaseLabel(mip_cc_label label);

MIP_CC_Label_GetId

Obtiene id. 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 mantener el nombre (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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
name Buffer [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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si nameBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y realNameSize se establecerá en el tamaño de búfer mínimo necesario.

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
description Buffer [Salida] Almacenar en búfer la descripción se copiará en.
descriptionBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si descriptionBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualDescriptionSize se establecerá en el tamaño de búfer mínimo necesario.

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 mantener el color (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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

MIP_CC_Label_GetColor

Obtiene color de etiqueta

Parámetros

Parámetro Descripción
etiqueta Etiqueta
colorBuffer [Salida] El búfer del color se copiará en (en #RRGGBB formato).
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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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. El valor más alto significa más sensible.

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

MIP_CC_Label_GetTooltip

Obtiene información sobre herramientas de etiquetas

Parámetros

Parámetro Descripción
etiqueta Etiqueta
tooltip Buffer [Salida] Almacenar en búfer la información sobre herramientas se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si tooltipBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualTooltipSize se establecerá en el tamaño de búfer mínimo necesario.

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

MIP_CC_Label_GetAutoTooltip

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

Parámetros

Parámetro Descripción
etiqueta Etiqueta
tooltip Buffer [Salida] Almacenar en búfer la información sobre herramientas se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si tooltipBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualTooltipSize se establecerá en el tamaño de búfer mínimo necesario.

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Solo se pueden aplicar etiquetas activas. Las etiquetas no se pueden aplicar y solo se usan para mostrar.

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 principal, si la hay

Parámetros

Parámetro Descripción
etiqueta Etiqueta
principal [Salida] Etiqueta principal, si la hay, de lo contrario, es null
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 secundarios

Parámetros

Parámetro Descripción
etiqueta Etiqueta
childrenSize [Salida] Número de niños
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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 de los niños

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 directiva de una etiqueta

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "configuración" llamando 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" para quitar

Parámetros

Parámetro Descripción
acción Acción de "metadatos"
metadataNames [Salida] Nombres clave de metadatos que se quitará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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La variable "metadataNames" debe ser publicada por el autor de la llamada llamando a MIP_CC_ReleaseStringList @note Quitar metadatos debe realizarse 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" para agregar

Parámetros

Parámetro Descripción
acción Acción de "metadatos"
metadatos [Salida] lista de entradas de metadatos para 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La variable "metadatos" debe ser publicada por el autor de la llamada llamando a MIP_CC_ReleaseDictionary @note La eliminación de metadatos debe realizarse 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

Crear un diccionario de claves o valores de cadena

Parámetros

Parámetro Descripción
entradas Matriz de entradas de metadatos
contar 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Una mip_cc_dictionary debe liberarse 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 redacten un diccionario

Parámetros

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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:La memoria de las "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 con un controlador de directivas

Parámetros

Parámetro Descripción
controlador Controlador de directivas que se lanzará
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
controlador Controlador de directivas
documentState Estado del documento
contexto El contexto de la aplicación se reenvía opacamente 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

Retorno:Código de resultado que indica que se ha dado é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
controlador Controlador de directivas
documentState Estado del documento
applicationState Estado de acción de la aplicación
contexto El contexto de la aplicación se reenvía opacamente a las devoluciones de llamada
actionResult [Salida] Acciones que deben realizarse por 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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar 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
controlador Controlador de directivas
documentState Estado del documento
applicationState Estado de acción de la aplicación
contexto El contexto de la aplicación se reenvía opacamente a las devoluciones de llamada
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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
acción Acción "proteger mediante una directiva de adhoc 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción Acción "proteger mediante una directiva de adhoc con doble clave"
url Buffer [Salida] Almacenar en búfer la dirección URL se copiará en.
urlBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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
acción Acción "proteger por dp no reenviar directiva con clave doble"
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

Retorno:Código de resultado que indica que se ha dado éxito o error

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
acción Acción "proteger por dp no reenviar directiva con clave doble"
url Buffer [Salida] Almacenar en búfer la dirección URL se copiará en.
urlBufferSize Tamaño (en número de caracteres) de la 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

Retorno:Código de resultado que indica que se ha dado éxito o error

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

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 los elementos de la interfaz de usuario de una acción de "quitar pie de página de contenido" para quitar

Parámetros

Parámetro Descripción
acción Acción "quitar pie de página de contenido"
nombres [Salida] Nombres de los elementos de la interfaz de usuario que se quitará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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "nombres" llamando 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 los elementos de la interfaz de usuario de una acción de "quitar encabezado de contenido" para quitar

Parámetros

Parámetro Descripción
acción Acción "quitar encabezado de contenido"
nombres [Salida] Nombres de los elementos de la interfaz de usuario que se quitará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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "nombres" llamando 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 los elementos de la interfaz de usuario de una acción de "quitar marca de agua" para quitar

Parámetros

Parámetro Descripción
acción Acción "quitar pie de página de marca de agua"
nombres [Salida] Nombres de los elementos de la interfaz de usuario que se quitará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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:El autor de la llamada debe publicar la variable "nombres" 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 con un tipo de confidencialidad

Parámetros

Parámetro Descripción
sensitivityType Tipo de confidencialidad que se va a publicar
void MIP_CC_ReleaseSensitivityType(mip_cc_sensitivity_type sensitivityType);

MIP_CC_SensitivityType_GetRulePackageIdSize

Obtiene el tamaño del búfer necesario para almacenar el id. 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 regla (en número de caracteres)
errorInfo [Salida] (Opcional) Información de error si el resultado de la operación es un error

Retorno:Código de resultado que indica que se ha dado é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 id. de paquete de reglas de un tipo de confidencialidad

Parámetros

Parámetro Descripción
sensitivityType Tipo de confidencialidad
idBuffer [Salida] Almacenar en búfer el id. se copiará en.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si idBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualIdSize se establecerá en el tamaño de búfer mínimo necesario.

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

Retorno:Código de resultado que indica que se ha dado é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] Almacenar en búfer el paquete de reglas se copiará en.
rulePackageBufferSize Tamaño (en número de caracteres) de la reglaPackageBuffer.
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

Retorno:Código de resultado que indica que se ha dado éxito o error

Nota:Si rulePackageBuffer es nulo o insuficiente, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER se devolverá y actualRulePackageSize se establecerá en el tamaño de búfer mínimo necesario.

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);