函数

mip_cc_auth_callback

用于获取 OAuth2 令牌的回调函数定义

参数

参数 说明
identity 要获取令牌的电子邮件地址
challenge OAuth2 质询
context 传递到导致此身份验证回调的 MIP API 的不透明应用程序上下文
tokenBuffer [输出]将令牌复制到的缓冲区。 如果为 null,则填充"actualTokenSize",但
tokenBufferSize 输出 (的大小) 字节数
actualTokenSize [输出]令牌 (大小) 字节数

返回:True 表示已检索令牌,否则为 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*);

回调函数定义,表示用户同意访问外部服务终结点

参数

参数 说明
url SDK 需要用户同意的 URL

返回:用户许可响应

MIP_CC_CALLBACK(mip_cc_consent_callback,
    mip_cc_consent,
    const char*);

MIP_CC_CreateDictionary

创建字符串键/值的字典

参数

参数 说明
条目 键/值对的数组
count 键/值对的数量
字典 [输出]新建的字典
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:mip_cc_dictionary调用 MIP_CC_ReleaseDictionary 释放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

获取组成字典的键/值对

参数

参数 说明
字典 源字典
条目 [输出]键/值对的数组,由对象mip_cc_dictionary的内存
count [输出]键/值对的数量
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"条目"的内存由 mip_cc_dictionary 对象所有,因此不应单独释放它

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

释放与字典关联的资源

参数

参数 说明
字典 要发布的词典
void MIP_CC_ReleaseDictionary(mip_cc_dictionary dictionary);

mip_cc_http_send_callback_fn

用于发出 HTTP 请求的回调函数定义

参数

参数 说明
request 应用程序要执行的 HTTP 请求
context 传递到 MIP API 调用的透明上下文导致此 HTTP 请求
MIP_CC_CALLBACK(mip_cc_http_send_callback_fn,
    void,
    const mip_cc_http_request*,
    const void*);

mip_cc_http_cancel_callback_fn

用于取消 HTTP 请求的回调函数定义

参数

参数 说明
requestId 要取消的 HTTP 请求的 ID
MIP_CC_CALLBACK(mip_cc_http_cancel_callback_fn,
    void,
    const char*);

MIP_CC_CreateHttpDelegate

创建可用于替代 MIP 的默认 HTTP 堆栈的 HTTP 委托

参数

参数 说明
sendCallback 用于发出 HTTP 请求的函数指针
cancelCallback 用于取消 HTTP 请求的函数指针
httpDelegate [输出]HTTP 委托对象的句柄
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

通知 HTTP 委托 HTTP 响应已就绪

参数

参数 说明
httpDelegate HTTP 委托对象的句柄
requestId 与此操作关联的 HTTP 请求的 ID
result 操作的成功/失败状态
response 如果操作成功,则 HTTP 响应,否则为 nullptr

注意:HTTP 操作完成后,应用程序必须调用此函数。 HTTP 响应的 ID 必须与 HTTP 请求的 ID 匹配,以便 MIP 将响应与其请求相关联

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

释放与 HTTP 委托句柄关联的资源

参数

参数 说明
httpDelegate 要释放的 HTTP 委托
void MIP_CC_ReleaseHttpDelegate(mip_cc_http_delegate httpDelegate);

mip_cc_logger_init_callback_fn

记录器初始化的回调函数定义

参数

参数 说明
storagePath 可以存储日志的文件路径
MIP_CC_CALLBACK(mip_cc_logger_init_callback_fn,
    void,
    const char*);

mip_cc_logger_write_callback_fn

用于编写日志语句的回调函数定义

参数

参数 说明
level 日志语句的日志级别。
消息 日志语句的消息。
函数 log 语句的函数名称。
文件 生成 log 语句的文件名。
line 生成日志语句的行号。
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

创建可用于替代 MIP 的默认记录器的记录器委托

参数

参数 说明
initCallback 用于初始化的函数指针
flushCallback 用于刷新日志的函数指针
writeCallback 用于编写日志语句的函数指针
loggerDelegate [输出]记录器委托对象的句柄
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

释放与记录器委托句柄关联的资源

参数

参数 说明
loggerDelegate 要释放的记录器委托
void MIP_CC_ReleaseLoggerDelegate(mip_cc_logger_delegate loggerDelegate);

MIP_CC_CreateMipContext

创建 MIP 上下文以管理跨所有配置文件实例共享的状态

参数

参数 说明
applicationInfo 有关使用保护 SDK 的应用程序的信息
path 存储日志记录、遥测和其他保护材料的文件路径
logLevel .miplog 的最低日志级别
isOfflineOnly 启用/禁用网络操作 (脱机时支持的所有)
loggerDelegateOverride (可选的) 记录器替代实现
telemetryOverride ("可选) 重写的遥测设置。 如果为 NULL,则使用默认设置
mipContext [输出]新建的 MIP 上下文实例
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

创建 MIP 上下文以管理跨所有配置文件实例共享的状态

参数

参数 说明
applicationInfo 有关使用保护 SDK 的应用程序的信息
path 存储日志记录、遥测和其他保护材料的文件路径
logLevel .miplog 的最低日志级别
isOfflineOnly 启用/禁用网络操作 (脱机时支持的所有)
loggerDelegateOverride (可选的) 记录器替代实现
telemetryOverride ("可选) 重写的遥测设置。 如果为 NULL,则使用默认设置
featureSettings (自定义) 替代数组的可选选项
featureSettingsSize 自定义功能覆盖的大小 (#A0)
mipContext [输出]新建的 MIP 上下文实例
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

发布与 MIP 上下文关联的资源

参数

参数 说明
mipContext 要发布的 MIP 上下文
void MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext);

MIP_CC_ProtectionDescriptor_GetProtectionType

获取保护类型,无论它是否由 RMS 模板定义

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
protectionType [输出]保护类型
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取存储所有者所需的缓冲区大小

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
ownerSize [输出]用于保存所有者 (的缓冲区大小(以字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetOwner

获取保护所有者

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
ownerBuffer [输出]将所有者复制到的缓冲区。
ownerBufferSize 大小 (ownerBuffer 的) 字符数。
actualOwnerSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 ownerBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER,并且 actualOwnerSize 将设置为所需的最小缓冲区大小。

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

获取存储名称所需的缓冲区大小

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
nameSize [输出]用于保存名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetName

获取保护名称

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
nameBuffer [输出]将名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取存储说明所需的缓冲区大小

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
descriptionSize [输出]用于保存描述的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetDescription

获取保护说明

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
descriptionBuffer [输出]将说明复制到的缓冲区。
descriptionBufferSize descriptionbuffer (字符数) 大小。
actualDescriptionSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 descriptionBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualDescriptionSize 将设置为所需的最小缓冲区大小。

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

获取模板 ID

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
templateId [输出]与保护关联的模板 ID
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取标签 ID

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
labelId [输出]与保护关联的标签 ID
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取内容 ID

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
contentId [输出]与保护关联的内容 ID
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取内容是否具有过期时间

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
doesContentExpire [输出]内容是否过期
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetContentValidUntil

获取自纪元以来 (保护过期时间(以)

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
contentValidUntil [输出]内容过期时间 (纪元开始以秒)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess

获取是否允许脱机访问

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
doesAllowOfflineAccess [输出]是否允许脱机访问
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetReferrerSize

获取存储引用资源所需的缓冲区大小

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
referrerSize [输出]用于保存引用 (的缓冲区大小(以字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetReferrer

获取保护引用者

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
referrerBuffer [输出]引用引用将复制到的缓冲区。
referrerBufferSize 引用 (缓冲区) 字符数的大小。
actualReferrerSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 referrerBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualReferrerSize 将设置为所需的最小缓冲区大小。

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

获取存储双密钥 URL 所需的缓冲区大小

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
url [输出]用于保存双键 URL 的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl

获取双密钥 URL

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
urlBuffer [输出]将 URL 复制到的缓冲区。
urlBufferSize 大小 (urlBuffer 的) 字符数。
actualUrlSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 urlBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回值,actualUrlSize 将设置为所需的最小缓冲区大小。

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

释放与保护描述符关联的资源

参数

参数 说明
protectionDescriptor 要发布的保护描述符
void MIP_CC_ReleaseProtectionDescriptor(mip_cc_protection_descriptor protectionDescriptor);

MIP_CC_CreateStringList

创建字符串列表

参数

参数 说明
strings 字符串数组
count 字符串数
stringList [输出]新建的字符串列表
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:mip_cc_string_list必须调用 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

获取组成字符串列表的字符串

参数

参数 说明
stringList 源字符串列表
strings [输出]字符串数组,由对象mip_cc_string_list的内存
count [输出]字符串数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"字符串"的内存由 mip_cc_string_list 对象所有,因此不应单独释放

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

发布与字符串列表关联的资源

参数

参数 说明
stringList 要发布的字符串列表
void MIP_CC_ReleaseStringList(mip_cc_string_list stringList);

mip_cc_dispatch_task_callback_fn

用于调度异步任务的回调函数定义

参数

参数 说明
taskId 唯一的任务标识符
MIP_CC_CALLBACK(mip_cc_dispatch_task_callback_fn,
    void,
    const mip_cc_async_task*);

mip_cc_cancel_task_callback_fn

用于取消后台任务的回调函数

参数

参数 说明
taskId 唯一的任务标识符

返回:如果任务已成功取消,则返回 True;否则为 false

MIP_CC_CALLBACK(mip_cc_cancel_task_callback_fn,
    bool,
    const char*);

MIP_CC_CreateTaskDispatcherDelegate

创建可用于替代 MIP 的默认异步任务处理的任务调度程序委托

参数

参数 说明
dispatchTaskCallback 用于调度异步任务的函数指针
cancelTaskCallback 用于取消后台任务的函数指针
cancelAllTasksCallback 用于取消所有后台任务的函数指针
taskDispatcher [输出]任务调度程序委托对象的句柄
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

通知 TaskDispatcher 委派任务计划在当前线程上立即执行

参数

参数 说明
taskDispatcher 任务调度程序委托对象的句柄
taskId 与此操作关联的异步任务的 ID

注意:当任务计划执行时,应用程序必须调用此函数。 它将导致立即在当前线程上执行任务。 ID 应匹配以前调度的非取消任务的 ID。

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

MIP_CC_ReleaseTaskDispatcherDelegate

释放与任务调度程序委派句柄关联的资源

参数

参数 说明
taskDispatcher 要释放的任务调度程序委托
void MIP_CC_ReleaseTaskDispatcherDelegate(mip_cc_task_dispatcher_delegate taskDispatcher);

MIP_CC_CreateTelemetryConfiguration

创建用于创建保护配置文件的设置对象

参数

参数 说明
telemetryConfig [输出]包含默认设置的新创建的遥测配置实例
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_TelemetryConfiguration_SetHostName

设置将替代内部遥测设置的遥测主机名

参数

参数 说明
telemetryConfig 遥测配置
hostName 主机名
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:当客户端应用程序使用相同的 Aria/1DS 遥测组件并且希望其内部遥测设置(例如缓存、日志记录、优先级等)时 (此属性) 使用 ,而不是 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

设置遥测数据共享库重写

参数

参数 说明
telemetryConfig 遥测配置
libraryName 实现 Aria/1DS SDK 的 C API 的 DLL 的名称
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:当客户端具有实现 Aria/1DS SDK 的 C API 的现有遥测 DLL 时,将设置此属性,该 API 应该使用而不是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

使用客户端自己的替代默认遥测 HTTP 堆栈

参数

参数 说明
telemetryConfig 遥测配置
httpDelegate 客户端应用程序实现的 HTTP 回调实例
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果未设置此属性,遥测组件将使用 MIP 的默认 HTTP 堆栈

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

使用客户端自己的替代默认异步任务调度程序

参数

参数 说明
telemetryConfig 遥测配置
taskDispatcherDelegate 客户端应用程序实现的任务调度程序回调实例
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

设置是否允许遥测组件在后台线程上 ping 网络状态

参数

参数 说明
telemetryConfig 遥测配置
isCachingEnabled 是否允许遥测组件 ping 后台线程上的网络状态
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:默认值为"true"

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

MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled

设置是否允许遥测组件将缓存写入磁盘

参数

参数 说明
telemetryConfig 遥测配置
isCachingEnabled 是否允许遥测组件将缓存写入磁盘
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:默认值为"true"

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

MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled

设置是否允许遥测组件将日志写入磁盘

参数

参数 说明
telemetryConfig 遥测配置
isTraceLoggingEnabled 是否允许遥测组件将日志写入磁盘
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:默认值为"true"

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

MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut

设置应用程序/用户是否选择退出可选遥测

参数

参数 说明
telemetryConfig 遥测配置
isTelemetryOptedOut 应用程序/用户是否选择退出可选遥测
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:默认值为"false"

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

MIP_CC_TelemetryConfiguration_SetCustomSettings

设置自定义遥测设置

参数

参数 说明
telemetryConfig 遥测配置
customSettings 自定义遥测设置
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

设置要屏蔽的遥测属性

参数

参数 说明
telemetryConfig 遥测配置
eventName 事件名称
propertyName 属性名称
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

释放与保护配置文件设置关联的资源

参数

参数 说明
profileSettings 要发布的保护配置文件设置
void MIP_CC_ReleaseTelemetryConfiguration(mip_cc_telemetry_configuration telemetryConfig);

MIP_CC_TemplateDescriptor_GetId

获取模板 ID

参数

参数 说明
protectionDescriptor 与受保护内容关联的描述符
templateId [输出]与保护关联的模板 ID
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取存储名称所需的缓冲区大小

参数

参数 说明
templateDescriptor 与模板关联的描述符
nameSize [输出]用于保存名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_TemplateDescriptor_GetName

获取模板名称

参数

参数 说明
templateDescriptor 与模板关联的描述符
nameBuffer [输出]将名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 NameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取存储说明所需的缓冲区大小

参数

参数 说明
templateDescriptor 与模板关联的描述符
descriptionSize [输出]用于保存描述的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_TemplateDescriptor_GetDescription

获取模板说明

参数

参数 说明
templateDescriptor 与模板关联的描述符
descriptionBuffer [输出]将说明复制到的缓冲区。
descriptionBufferSize descriptionbuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 descriptionBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualDescriptionSize 将设置为所需的最小缓冲区大小。

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

发布与模板描述符关联的资源

参数

参数 说明
templateDescriptor 要发布的模板描述符
void MIP_CC_ReleaseTemplateDescriptor(mip_cc_template_descriptor templateDescriptor);

MIP_CC_ActionResult_GetActions

获取构成操作结果的操作

参数

参数 说明
actionResult 源操作结果
actions [输出]操作数组,由对象mip_cc_action_result的内存
count [输出]键/值对的数量
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"操作"的内存由 mip_cc_action_result 对象所有,因此不应单独释放

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

释放与操作结果关联的资源

参数

参数 说明
actionResult 要释放的操作结果
void MIP_CC_ReleaseActionResult(mip_cc_action_result actionResult);

MIP_CC_AddContentFooterAction_GetUIElementNameSize

获取存储"添加内容页脚"操作 UI 元素名称所需的缓冲区大小

参数

参数 说明
action "添加内容页脚"操作
nameSize [输出]用于保存 UI 元素名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentFooterAction_GetUIElementName

获取"添加内容页脚"操作 UI 元素名称

参数

参数 说明
action "添加内容页脚"操作
nameBuffer [输出]将 UI 元素名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取存储"添加内容页脚"操作文本所需的缓冲区大小

参数

参数 说明
action "添加内容页脚"操作
nameSize [输出]用于保存文本的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentFooterAction_GetText

获取"添加内容页脚"操作的文本

参数

参数 说明
action "添加内容页脚"操作
textBuffer [输出]将文本复制到的缓冲区。
textBufferSize textBuffer (字符数) 大小。
actualTextSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 textBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualTextSize 将设置为所需的最小缓冲区大小。

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

获取存储"添加内容页脚"操作字体名称所需的缓冲区大小

参数

参数 说明
action "添加内容页脚"操作
nameSize [输出]用于保存字体名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentFooterAction_GetFontName

获取"添加内容页脚"操作字体名称

参数

参数 说明
action "添加内容页脚"操作
nameBuffer [输出]将字体名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取整数字号

参数

参数 说明
action "添加内容页脚"操作
fontSize [输出]字号
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentFooterAction_GetFontColorSize

获取存储"添加内容页脚"操作字体颜色所需的缓冲区大小

参数

参数 说明
action "添加内容页脚"操作
colorSize [输出]用于保存字体颜色缓冲区的大小 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentFooterAction_GetFontColor

获取"添加内容页脚"操作字体颜色 (例如"#000000")

参数

参数 说明
action "添加内容页脚"操作
colorBuffer [输出]将字体颜色复制到的缓冲区。
colorBufferSize 大小 (colorBuffer) 字符数。
actualColorSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 colorBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualColorSize 将设置为所需的最小缓冲区大小。

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

获取对齐方式

参数

参数 说明
action "添加内容页脚"操作
alignment [输出]对齐方式
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取边距大小

参数

参数 说明
action "添加内容页脚"操作
marginSize [输出]页边距大小 (mm)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetUIElementNameSize

获取存储"添加内容标头"操作 UI 元素名称所需的缓冲区大小

参数

参数 说明
action "添加内容标头"操作
nameSize [输出]用于保存 UI 元素名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetUIElementName

获取"添加内容标头"操作 UI 元素名称

参数

参数 说明
action "添加内容标头"操作
nameBuffer [输出]将 UI 元素名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取存储"添加内容标头"操作文本所需的缓冲区大小

参数

参数 说明
action "添加内容标头"操作
nameSize [输出]用于保存文本的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetText

获取"添加内容标题"操作的文本

参数

参数 说明
action "添加内容标头"操作
textBuffer [输出]将文本复制到的缓冲区。
textBufferSize textBuffer (字符数) 大小。
actualTextSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 textBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualTextSize 将设置为所需的最小缓冲区大小。

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

获取存储"添加内容标头"操作字体名称所需的缓冲区大小

参数

参数 说明
action "添加内容标头"操作
nameSize [输出]用于保存字体名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetFontName

获取"添加内容标题"操作字体名称

参数

参数 说明
action "添加内容标头"操作
nameBuffer [输出]将字体名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取整数字号

参数

参数 说明
action "添加内容标头"操作
fontSize [输出]字号
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetFontColorSize

获取存储"添加内容标头"操作字体颜色所需的缓冲区大小

参数

参数 说明
action "添加内容标头"操作
colorSize [输出]用于保存字体颜色缓冲区的大小 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddContentHeaderAction_GetFontColor

获取"添加内容标题"操作字体颜色 (例如"#000000")

参数

参数 说明
action "添加内容标头"操作
colorBuffer [输出]将字体颜色复制到的缓冲区。
colorBufferSize 大小 (colorBuffer) 字符数。
actualColorSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 colorBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualColorSize 将设置为所需的最小缓冲区大小。

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

获取对齐方式

参数

参数 说明
action "添加内容标头"操作
alignment [输出]对齐方式
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取边距大小

参数

参数 说明
action "添加内容标头"操作
marginSize [输出]页边距大小 (mm)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetUIElementNameSize

获取存储"添加水印"操作 UI 元素名称所需的缓冲区大小

参数

参数 说明
action "添加水印"操作
nameSize [输出]用于保存 UI 元素名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetUIElementName

获取"添加水印"操作 UI 元素名称

参数

参数 说明
action "添加水印"操作
nameBuffer [输出]将 UI 元素名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取水印布局

参数

参数 说明
action "添加水印"操作
布局 [输出]水印布局
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取存储"添加水印"操作的文本所需的缓冲区大小

参数

参数 说明
action "添加水印"操作
textSize [输出]用于保存文本的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetText

获取"添加水印"操作的文本

参数

参数 说明
action "添加水印"操作
textBuffer [输出]将文本复制到的缓冲区。
textBufferSize textBuffer (字符数) 大小。
actualTextSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 textBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualTextSize 将设置为所需的最小缓冲区大小。

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

获取存储"添加水印"操作字体名称所需的缓冲区大小

参数

参数 说明
action "添加水印"操作
nameSize [输出]用于保存字体名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetFontName

获取"添加水印"操作字体名称

参数

参数 说明
action "添加水印"操作
nameBuffer [输出]将字体名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取整数字号

参数

参数 说明
action "添加水印"操作
fontSize [输出]字号
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetFontColorSize

获取存储"添加水印"操作字体颜色所需的缓冲区大小

参数

参数 说明
action "添加水印"操作
colorSize [输出]用于保存字体颜色缓冲区的大小 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_AddWatermarkAction_GetFontColor

获取"添加水印"操作字体颜色 (例如"#000000")

参数

参数 说明
action "添加水印"操作
colorBuffer [输出]将字体颜色复制到的缓冲区。
colorBufferSize 大小 (colorBuffer) 字符数。
actualColorSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 colorBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualColorSize 将设置为所需的最小缓冲区大小。

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

发布与内容标签关联的资源

参数

参数 说明
contentLabel 要释放的标签
void MIP_CC_ReleaseContentLabel(mip_cc_content_label contentLabel);

MIP_CC_ContentLabel_GetCreationTime

获取应用标签的时间

参数

参数 说明
contentLabel 标签
creationTime [输出]从纪元开始,将标签应用到文档 (的时间(以秒)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ContentLabel_GetAssignmentMethod

获取标签分配方法

参数

参数 说明
contentLabel 标签
assignmentMethod [输出]分配 (方法,例如"standard"或"privileged")
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

获取扩展属性

参数

参数 说明
contentLabel 标签
properties [输出]扩展属性字典,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"properties"变量必须由调用方通过调用 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

获取标签是否应用了保护。

参数

参数 说明
contentLabel 标签
isProtectionAppliedByLabel [输出]如果文档受保护,并且此标签显式应用了保护。
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ContentLabel_GetLabel

从内容标签实例获取通用标签属性

参数

参数 说明
contentLabel 标签
label [输出]通用标签,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"label"变量必须由调用方通过调用 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

获取存储"自定义"操作名称所需的缓冲区大小

参数

参数 说明
action "自定义"操作
nameSize [输出]用于保存名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_CustomAction_GetName

获取"自定义"操作的名称

参数

参数 说明
action "自定义"操作
nameBuffer [输出]将名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取"自定义"操作的属性

参数

参数 说明
action "自定义"操作
properties [输出]属性字典,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"properties"变量必须由调用方通过调用 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

释放与标签关联的资源

参数

参数 说明
label 要释放的标签
void MIP_CC_ReleaseLabel(mip_cc_label label);

MIP_CC_Label_GetId

获取标签 ID

参数

参数 说明
label 标签
labelId [输出]标签 ID
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetNameSize

获取存储名称所需的缓冲区大小

参数

参数 说明
label 标签
nameSize [输出]用于保存名称的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetName

获取标签名称

参数

参数 说明
label 标签
nameBuffer [输出]将名称复制到的缓冲区。
nameBufferSize nameBuffer (字符数) 大小。
actualNameSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 nameBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualNameSize 将设置为所需的最小缓冲区大小。

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

获取存储说明所需的缓冲区大小

参数

参数 说明
label 标签
descriptionSize [输出]用于保存描述的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetDescription

获取标签说明

参数

参数 说明
label 标签
descriptionBuffer [输出]将说明复制到的缓冲区。
descriptionBufferSize descriptionbuffer (字符数) 大小。
actualDescriptionSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 descriptionBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualDescriptionSize 将设置为所需的最小缓冲区大小。

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

获取存储颜色所需的缓冲区大小

参数

参数 说明
label 标签
colorSize [输出]用于保存颜色 (缓冲区的大小(以字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetColor

获取标签颜色

参数

参数 说明
label 标签
colorBuffer [输出]将颜色复制到缓冲区中 (以#RRGGBB格式) 。
colorBufferSize 大小 (colorBuffer) 字符数。
actualColorSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 colorBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualColorSize 将设置为所需的最小缓冲区大小。

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

获取标签的敏感度级别。 值越高,越敏感。

参数

参数 说明
label 标签
敏感度 [输出]敏感度级别
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetTooltipSize

获取存储工具提示所需的缓冲区大小

参数

参数 说明
label 标签
tooltipSize [输出]用于保存工具提示的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetTooltip

获取标签工具提示

参数

参数 说明
label 标签
tooltipBuffer [输出]将工具提示复制到的缓冲区。
tooltipBufferSize 调整 (tipBuffer 的) 字符数。
actualTooltipSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 tooltipBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualTooltipSize 将设置为所需的最小缓冲区大小。

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

获取存储自动分类工具提示所需的缓冲区大小

参数

参数 说明
label 标签
tooltipSize [输出]用于保存工具提示的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetAutoTooltip

获取标签自动分类工具提示

参数

参数 说明
label 标签
tooltipBuffer [输出]将工具提示复制到的缓冲区。
tooltipBufferSize 调整 (tipBuffer 的) 字符数。
actualTooltipSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 tooltipBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualTooltipSize 将设置为所需的最小缓冲区大小。

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

获取标签是否处于活动状态

参数

参数 说明
label 标签
isActive [输出]标签是否被视为活动标签。
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:只能应用活动标签。 无法应用停用标签,并且仅用于显示目的。

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

MIP_CC_Label_GetParent

获取父标签(如果有)

参数

参数 说明
label 标签
parent [输出]父标签(如果有)否则为 null
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetChildrenSize

获取子标签数

参数

参数 说明
label 标签
childrenSize [输出]子女数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_Label_GetChildren

获取子标签

参数

参数 说明
label 标签
childrenBuffer [输出]将子标签复制到的缓冲区。 子标签
childrenBufferSize 大小 (子缓冲区) 标签数。
actual一系列 [输出]写入缓冲区的子标签数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 childrenBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER将返回一个缓冲区,actual的一个缓冲区大小将设置为所需的最小缓冲区大小

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

获取标签的策略定义自定义设置

参数

参数 说明
label 标签
设置 [输出]设置字典,由调用方拥有
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"settings"变量必须由调用方通过调用 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

获取要删除的"元数据"操作元数据

参数

参数 说明
action "metadata"操作
metadataNames [输出]要删除的元数据的键名称、调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"metadataNames"变量必须由调用方通过调用 来MIP_CC_ReleaseStringList @note元数据应在添加元数据之前完成

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

获取要添加的"元数据"操作元数据

参数

参数 说明
action "metadata"操作
metadata [输出] 要添加的元数据条目列表,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:调用方必须通过调用 来释放"metadata"变量MIP_CC_ReleaseDictionary @note元数据应在添加元数据之前完成删除元数据

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

MIP_CC_CreateMetadataDictionary

创建字符串键/值的字典

参数

参数 说明
条目 元数据条目数组
count 元数据条目数
字典 [输出]新建的字典
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:mip_cc_dictionary调用 MIP_CC_ReleaseDictionary 释放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

获取构成字典的元数据条目

参数

参数 说明
字典 源字典
条目 [输出]元数据条目数组,由对象mip_cc_dictionary的内存
count [输出]元数据条目数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"条目"的内存由 mip_cc_dictionary 对象所有,因此不应单独释放它

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

释放与字典关联的资源

参数

参数 说明
字典 要发布的词典
void MIP_CC_ReleaseMetadataDictionary(mip_cc_metadata_dictionary dictionary);

MIP_CC_ReleasePolicyHandler

释放与策略处理程序关联的资源

参数

参数 说明
处理程序 要释放的策略处理程序
void MIP_CC_ReleasePolicyHandler(mip_cc_policy_handler handler);

MIP_CC_PolicyHandler_GetSensitivityLabel

获取文档的当前标签

参数

参数 说明
处理程序 策略处理程序
documentState 文档状态
context 以不透明方法转发到任何回调的应用程序上下文
contentLabel 当前应用于文档的标签
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

根据提供的状态执行策略规则并确定相应的操作

参数

参数 说明
处理程序 策略处理程序
documentState 文档状态
applicationState 应用程序操作状态
context 以不透明方法转发到任何回调的应用程序上下文
actionResult [输出]应用程序、调用方拥有的内存应采取的操作
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"actionResult"变量必须由调用方通过调用 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

应用计算操作并将数据提交到磁盘后由应用程序调用

参数

参数 说明
处理程序 策略处理程序
documentState 文档状态
applicationState 应用程序操作状态
context 以不透明方法转发到任何回调的应用程序上下文
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:必须调用此函数来传输完整的标签审核数据。

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

获取存储双密钥加密 URL 所需的缓冲区大小。

参数

参数 说明
action "使用双键保护临时策略"操作
urlSize [输出]用于保存 URL 的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrl

获取双密钥加密 URL

参数

参数 说明
action "使用双键保护临时策略"操作
urlBuffer [输出]将 URL 复制到的缓冲区。
urlBufferSize urlBuffer (字符数) 大小。
actualUrlSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 urlBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualUrlSize 将设置为所需的最小缓冲区大小。

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

获取存储双密钥加密 URL 所需的缓冲区大小。

参数

参数 说明
action "使用双密钥保护 dp 不转发策略"操作
urlSize [输出]用于保存 URL 的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrl

获取双密钥加密 URL

参数

参数 说明
action "使用双密钥保护 dp 不转发策略"操作
urlBuffer [输出]将 URL 复制到的缓冲区。
urlBufferSize urlBuffer (字符数) 大小。
actualUrlSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 urlBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualUrlSize 将设置为所需的最小缓冲区大小。

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

获取"删除内容页脚"操作要删除的 UI 元素名称

参数

参数 说明
action "删除内容页脚"操作
names [输出]要删除的 UI 元素的名称,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"names"变量必须由调用方通过调用 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

获取要删除的"删除内容标头"操作 UI 元素名称

参数

参数 说明
action "删除内容标头"操作
names [输出]要删除的 UI 元素的名称,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"names"变量必须由调用方通过调用 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

获取"删除水印"操作要删除的 UI 元素名称

参数

参数 说明
action "删除水印页脚"操作
names [输出]要删除的 UI 元素的名称,调用方拥有的内存
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:"names"变量必须由调用方通过调用 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

发布与敏感度类型关联的资源

参数

参数 说明
sensitivityType 要释放的敏感度类型
void MIP_CC_ReleaseSensitivityType(mip_cc_sensitivity_type sensitivityType);

MIP_CC_SensitivityType_GetRulePackageIdSize

获取存储敏感度类型的规则包 ID 所需的缓冲区大小

参数

参数 说明
sensitivityType 敏感度类型
idSize [输出]用于保存规则包 ID 的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_SensitivityType_GetRulePackageId

获取敏感度类型的规则包 ID

参数

参数 说明
sensitivityType 敏感度类型
idBuffer [输出]将 ID 复制到的缓冲区。
idBufferSize 大小 (idBuffer 的) 字符数。
actualIdSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 idBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER,并且 actualIdSize 将设置为所需的最小缓冲区大小。

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

获取存储敏感度类型的规则包所需的缓冲区大小

参数

参数 说明
sensitivityType 敏感度类型
rulePackageSize [输出]用于保存规则包的缓冲区 (字符数)
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

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

MIP_CC_SensitivityType_GetRulePackage

获取敏感度类型的规则包

参数

参数 说明
sensitivityType 敏感度类型
rulePackageBuffer [输出]将规则包复制到的缓冲区。
rulePackageBufferSize 大小 (rulePackageBuffer) 字符数。
actualRulePackageSize [输出]写入缓冲区的字符数
errorInfo [输出] (错误) 错误时返回可选选项"失败信息"

返回:指示成功或失败的结果代码

注意:如果 rulePackageBuffer 为 null 或不足,MIP_RESULT_ERROR_INSUFFICIENT_BUFFER返回,actualRulePackageSize 将设置为所需的最小缓冲区大小。

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