Funkcje
mip_cc_auth_callback
definicja funkcji callback dla uzyskiwania tokenu OAuth2
Parametry
| Parametr | Opis |
|---|---|
| tożsamość | Adres e-mail, na który zostanie nabyte token |
| wyzwanie | Wyzwanie OAuth2 |
| kontekst | Nieprzezroczysty kontekst aplikacji przekazany do interfejsu API miP, w wyniku czego zostało to wywołanie uwierzytelniania |
| tokenBuffer | [Dane wyjściowe] Bufor, do którego zostanie skopiowany token. Jeśli wartość null, wartość 'actualTokenSize' będzie wypełniona, ale |
| tokenBufferSize | Rozmiar (w bajtach) buforu wyjściowego |
| actualTokenSize | [Dane wyjściowe] Rzeczywisty rozmiar tokenu (w bajtach) |
Zwróć:Prawda to token został pobrany, w innym przypadku fałsz
MIP_CC_CALLBACK(mip_cc_auth_callback,
bool,
const mip_cc_identity*,
const mip_cc_oauth2_challenge*,
const void*,
uint8_t*,
const int64_t,
int64_t*);
mip_cc_consent_callback
definicja funkcji callback w celu uzyskania zgody użytkownika na uzyskiwanie dostępu do punktu końcowego usługi zewnętrznej
Parametry
| Parametr | Opis |
|---|---|
| adres URL | Adres URL, dla którego zestaw SDK wymaga zgody użytkownika |
Zwrot:odpowiedź na zgodę użytkownika
MIP_CC_CALLBACK(mip_cc_consent_callback,
mip_cc_consent,
const char*);
MIP_CC_CreateDictionary
Tworzenie słownika z kluczami/wartościami ciągów
Parametry
| Parametr | Opis |
|---|---|
| wpisy | Tablica par klucz/wartość |
| liczba | Liczba par klucz/wartość |
| słownik | [Dane wyjściowe] Nowo utworzony słownik |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:aby można było mip_cc_dictionary, należy dzwonić do 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
Uzyskiwanie par klucz/wartość, które tworzą słownik
Parametry
| Parametr | Opis |
|---|---|
| słownik | Słownik źródłowy |
| wpisy | [Dane wyjściowe] Tablica par klucz/wartość, pamięć należąca do mip_cc_dictionary obiektu |
| liczba | [Dane wyjściowe] Liczba par klucz/wartość |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Pamięć "wpisów" należy do obiektu mip_cc_dictionary, więc nie powinna być uwolniona niezależnie
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
Zwalnianie zasobów skojarzonych ze słownikiem
Parametry
| Parametr | Opis |
|---|---|
| słownik | Słownik do opublikowanych |
void MIP_CC_ReleaseDictionary(mip_cc_dictionary dictionary);
mip_cc_http_send_callback_fn
Definicja funkcji callback w celu wydania żądania HTTP
Parametry
| Parametr | Opis |
|---|---|
| żądanie | Żądanie HTTP do wykonania przez aplikację |
| kontekst | Ten sam kontekst nieprzezroczystości przekazany do wywołania interfejsu API MIP, co było wynikiem tego żądania HTTP |
MIP_CC_CALLBACK(mip_cc_http_send_callback_fn,
void,
const mip_cc_http_request*,
const void*);
mip_cc_http_cancel_callback_fn
Definicja funkcji callback w celu anulowania żądania HTTP
Parametry
| Parametr | Opis |
|---|---|
| requestId | Identyfikator żądania HTTP do anulowania |
MIP_CC_CALLBACK(mip_cc_http_cancel_callback_fn,
void,
const char*);
MIP_CC_CreateHttpDelegate
Tworzy pełnomocnika HTTP, którego można użyć do zastąpienia domyślnego stosu HTTP protokołu MIP.
Parametry
| Parametr | Opis |
|---|---|
| sendCallback | Wskaźnik funkcji do wydawania żądań HTTP |
| cancelCallback | Wskaźnik funkcji do anulowania żądań HTTP |
| httpDelegate | [Dane wyjściowe] Obsługa obiektu pełnomocnika HTTP |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Powiadomienie dla pełnomocnika HTTP, że odpowiedź HTTP jest gotowa
Parametry
| Parametr | Opis |
|---|---|
| httpDelegate | Obsługa obiektu pełnomocnika HTTP |
| requestId | Identyfikator żądania HTTP skojarzonego z tą operacją |
| wynik | Powodzenie/stan niepowodzenia operacji |
| odpowiedź | Odpowiedź HTTP, jeśli operacja się powiedzie, w innym przypadku nullptr |
Uwaga:Po ukończeniu operacji HTTP ta funkcja musi zostać wywołana przez aplikację. Identyfikator odpowiedzi HTTP musi odpowiadać identyfikatorowi żądania HTTP, aby umożliwić skorelowanie odpowiedzi z jej żądaniem za pomocą protokołu 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
Zwalnianie zasobów skojarzonych z uchwytem pełnomocnika HTTP
Parametry
| Parametr | Opis |
|---|---|
| httpDelegate | Pełnomocnik HTTP do zesłania |
void MIP_CC_ReleaseHttpDelegate(mip_cc_http_delegate httpDelegate);
mip_cc_logger_init_callback_fn
Definicja funkcji callback do inicjowania logi
Parametry
| Parametr | Opis |
|---|---|
| storagePath | Ścieżka pliku, na której mogą być przechowywane dzienniki |
MIP_CC_CALLBACK(mip_cc_logger_init_callback_fn,
void,
const char*);
mip_cc_logger_write_callback_fn
Definicja funkcji callback do pisania instrukcji dziennika
Parametry
| Parametr | Opis |
|---|---|
| poziom | poziom dziennika instrukcji log. |
| Komunikat | komunikat instrukcji dziennika. |
| funkcja | nazwę funkcji instrukcji log. |
| plik | nazwa pliku, w którym została wygenerowana instrukcja dziennika. |
| wiersz | numer wiersza, na którym została wygenerowana instrukcja dziennika; |
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
Tworzy pełnomocnika loglogowego, którego można użyć do zastąpienia domyślnego pełnomocnika MIP.
Parametry
| Parametr | Opis |
|---|---|
| initCallback | Wskaźnik funkcji do inicjowania |
| flushCallback | Wskaźnik funkcji do opróżniania dzienników |
| writeCallback | Wskaźnik funkcji do pisania instrukcji dziennika |
| loglogiaDelegate | [Dane wyjściowe] Uchwyt do obiektu pełnomocnika loglogii |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Zwalnianie zasobów skojarzonych z uchwytem pełnomocnika loglogii
Parametry
| Parametr | Opis |
|---|---|
| loglogiaDelegate | Pełnomocnik logi, który zostanie wydany |
void MIP_CC_ReleaseLoggerDelegate(mip_cc_logger_delegate loggerDelegate);
MIP_CC_CreateMipContext
Tworzenie kontekstu usługi miP w celu zarządzania stanem udostępnionym we wszystkich wystąpieniach profilu
Parametry
| Parametr | Opis |
|---|---|
| applicationInfo | Informacje o aplikacji, która konsumuje zestaw SDK ochrony |
| ścieżka | Ścieżka pliku, na podstawie której jest przechowywane rejestrowanie, telemetria i inne materiały dotyczące ochrony |
| logLevel | Minimalny poziom dziennika dla miplog |
| isOfflineOnly | Włączanie/wyłączanie operacji sieciowych (nie wszystkie akcje obsługiwane w trybie offline) |
| loglogiaDelegateOverride | (Opcjonalnie) Implementacja zastępowania Logi |
| telemetryOverride | (Opcjonalnie) Zastąpić ustawienia telemetrii. W przypadku wartości NULL zostaną użyte ustawienia domyślne |
| mipContext | [Dane wyjściowe] Nowo utworzone wystąpienie kontekstowe usługi miP |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Tworzenie kontekstu usługi miP w celu zarządzania stanem udostępnionym we wszystkich wystąpieniach profilu
Parametry
| Parametr | Opis |
|---|---|
| applicationInfo | Informacje o aplikacji, która konsumuje zestaw SDK ochrony |
| ścieżka | Ścieżka pliku, na podstawie której jest przechowywane rejestrowanie, telemetria i inne materiały dotyczące ochrony |
| logLevel | Minimalny poziom dziennika dla miplog |
| isOfflineOnly | Włączanie/wyłączanie operacji sieciowych (nie wszystkie akcje obsługiwane w trybie offline) |
| loglogiaDelegateOverride | (Opcjonalnie) Implementacja zastępowania Logi |
| telemetryOverride | (Opcjonalnie) Zastąpić ustawienia telemetrii. W przypadku wartości NULL zostaną użyte ustawienia domyślne |
| featureSettings | (Opcjonalnie) Tablica niestandardowych zastępować funkcji |
| featureSettingsSize | Rozmiar niestandardowych zastępować funkcji (w # zastępować) |
| mipContext | [Dane wyjściowe] Nowo utworzone wystąpienie kontekstowe usługi miP |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Zwalnianie zasobów skojarzonych z kontekstem miP
Parametry
| Parametr | Opis |
|---|---|
| mipContext | Kontekst miP do opublikowanych |
void MIP_CC_ReleaseMipContext(mip_cc_mip_context mipContext);
MIP_CC_ProtectionDescriptor_GetProtectionType
Pobiera typ ochrony, niezależnie od tego, czy jest on zdefiniowany za pomocą szablonu RMS, czy nie
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| protectionType | [Dane wyjściowe] Typ ochrony |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Otrzymuje rozmiar buforu wymaganego dla właściciela magazynu
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| ownerSize | [Dane wyjściowe] Rozmiar buforu do przechowywania właściciela (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetOwnerSize(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* ownerSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetOwner
Otrzymuje właściciela ochrony
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| ownerBuffer | [Dane wyjściowe] Bufor, do który zostanie skopiowany właściciel. |
| ownerBufferSize | Rozmiar (w liczbie znaków) właścicielaBuffer. |
| actualOwnerSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość ownerBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualOwnerSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania nazwy
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetNameSize(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetName
Otrzymuje nazwę ochrony
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania opisu
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| descriptionSize | [Dane wyjściowe] Rozmiar buforu do przechowywania opisu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetDescriptionSize(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* descriptionSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetDescription
Otrzymuje opis ochrony
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| descriptionBuffer | [Dane wyjściowe] Buforuj opis, do który zostanie skopiowany. |
| descriptionBufferSize | Rozmiar (w liczbie znaków) opisuBuffer. |
| actualDescriptionSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość descriptionBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość ActualDescriptionSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera identyfikator szablonu
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| templateId | [Dane wyjściowe] Identyfikator szablonu skojarzonego z ochroną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera identyfikator etykiety
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| labelId | [Dane wyjściowe] Identyfikator etykiety skojarzony z ochroną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera identyfikator zawartości
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| contentId | [Dane wyjściowe] Identyfikator zawartości skojarzony z ochroną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Określa, czy zawartość ma czas wygaśnięcia
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| doesContentExpire | [Dane wyjściowe] Czy zawartość wygasa |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_DoesContentExpire(
const mip_cc_protection_descriptor protectionDescriptor,
bool* doesContentExpire,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetContentValidUntil
Otrzymuje czas wygaśnięcia ochrony (w sekundach od czasu echu)
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| contentValidUntil | [Dane wyjściowe] Czas wygaśnięcia zawartości (w sekundach od daty) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetContentValidUntil(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* contentValidUntil,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess
Określa, czy jest dozwolony dostęp w trybie offline
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| doesAllowOfflineAccess | [Dane wyjściowe] Czy jest dozwolony dostęp w trybie offline |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_DoesAllowOfflineAccess(
const mip_cc_protection_descriptor protectionDescriptor,
bool* doesAllowOfflineAccess,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetReferrerSize
Pobiera rozmiar buforu wymaganego do przechowywania osób polecanych
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| referrerSize | [Dane wyjściowe] Rozmiar buforu do przechowywania osób polecanych (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetReferrerSize(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* referrerSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetReferrer
Pobiera polecanie ochrony
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| referrerBuffer | [Dane wyjściowe] Bufor, do który zostanie skopiowana polecana zawartość. |
| referrerBufferSize | Rozmiar (w liczbie znaków) of the referrerBuffer. |
| actualReferrerSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli ciąg referrerBuffer ma wartość null lub jest niewystarczający, zostanie zwrócony MIP_RESULT_ERROR_INSUFFICIENT_BUFFER, a wartość actualReferrerSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Uzyskuje rozmiar bufora wymaganego do przechowywania adresu URL z podwójną kluczem.
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| adres URL | [Dane wyjściowe] Rozmiar bufora do przechowywania adresu URL z podwójnym kluczem (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectionDescriptor_GetDoubleKeyUrlSize(
const mip_cc_protection_descriptor protectionDescriptor,
int64_t* urlSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectionDescriptor_GetDoubleKeyUrl
Pobiera adres URL z podwójnym kluczem
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| urlBuffer | [Dane wyjściowe] Buforuj adres URL, do który zostanie skopiowany. |
| urlBufferSize | Rozmiar (w liczbie znaków) okna urlBuffer. |
| actualUrlSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość urlBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualUrlSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Zwalnianie zasobów skojarzonych z deskryptorem ochrony
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor ochrony do rozsyłania |
void MIP_CC_ReleaseProtectionDescriptor(mip_cc_protection_descriptor protectionDescriptor);
MIP_CC_CreateStringList
Tworzenie listy ciągów
Parametry
| Parametr | Opis |
|---|---|
| ciągi | Tablica ciągów |
| liczba | Liczba ciągów |
| stringList | [Dane wyjściowe] Nowo utworzona lista ciągów |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:aby można było mip_cc_string_list, należy dzwonić do 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
Uzyskiwanie ciągów redagowania listy ciągów
Parametry
| Parametr | Opis |
|---|---|
| stringList | Lista ciągów źródłowych |
| ciągi | [Dane wyjściowe] Tablica ciągów, pamięć należąca do mip_cc_string_list obiektu |
| liczba | [Dane wyjściowe] Liczba ciągów |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Pamięć "ciągów" należy do obiektu mip_cc_string_list, więc nie powinna być wolny niezależnie
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
Zwalnianie zasobów skojarzonych z listą ciągów
Parametry
| Parametr | Opis |
|---|---|
| stringList | Lista ciągów do opublikowanych |
void MIP_CC_ReleaseStringList(mip_cc_string_list stringList);
mip_cc_dispatch_task_callback_fn
Definicja funkcji wywoływania dla wysyłania zadania synchronizacji
Parametry
| Parametr | Opis |
|---|---|
| taskId | Unikatowy identyfikator zadania |
MIP_CC_CALLBACK(mip_cc_dispatch_task_callback_fn,
void,
const mip_cc_async_task*);
mip_cc_cancel_task_callback_fn
Funkcja callback do anulowania zadań w tle
Parametry
| Parametr | Opis |
|---|---|
| taskId | Unikatowy identyfikator zadania |
Zwróć:Prawda, jeśli zadanie zostało pomyślnie anulowane, w innym przypadku fałsz
MIP_CC_CALLBACK(mip_cc_cancel_task_callback_fn,
bool,
const char*);
MIP_CC_CreateTaskDispatcherDelegate
Tworzy pełnomocnika dyspozytora zadań, którego można użyć do zastąpienia domyślnej obsługi zadań synchronizacji miP.
Parametry
| Parametr | Opis |
|---|---|
| dispatchTaskCallback | Wskaźnik funkcji do wysyłania zadań synchronizacji |
| cancelTaskCallback | Wskaźnik funkcji do anulowania zadań w tle |
| cancelAllTasksCallback | Wskaźnik funkcji do anulowania wszystkich zadań w tle |
| taskDispatcher | [Dane wyjściowe] Obsługa obiektu pełnomocnika dyspozycyjnika zadania |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Wyświetla pełnomocnikowi ds. zadańwyświetlaczego powiadomienie o zaplanowanym wykonaniu zadania w bieżącym wątku.
Parametry
| Parametr | Opis |
|---|---|
| taskDispatcher | Obsługa obiektu pełnomocnika dyspozycyjnika zadania |
| taskId | Identyfikator zadania synchronizacji skojarzonego z tą operacją |
Uwaga:Ta funkcja musi być wywoływana przez aplikację, gdy zaplanowano wykonanie zadania. Spowoduje to natychmiastowe wykonanie zadania w bieżącym wątku. Identyfikator powinien być taki, jak w przypadku wcześniej wysłanego, nie anulowanych zadań.
void MIP_CC_ExecuteDispatchedTask(const mip_cc_task_dispatcher_delegate taskDispatcher, const char* taskId);
MIP_CC_ReleaseTaskDispatcherDelegate
Zwalnianie zasobów skojarzonych z uchwytem pełnomocnika dyspozytora zadania
Parametry
| Parametr | Opis |
|---|---|
| taskDispatcher | Pełnomocnika do wysyłania zadań |
void MIP_CC_ReleaseTaskDispatcherDelegate(mip_cc_task_dispatcher_delegate taskDispatcher);
MIP_CC_CreateTelemetryConfiguration
Tworzenie obiektu ustawień używanego do tworzenia profilu ochrony
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | [Dane wyjściowe] Nowo utworzone wystąpienie konfiguracji telemetrii zawierające ustawienia domyślne |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_CreateTelemetryConfiguration(
mip_cc_telemetry_configuration* telemetryConfig,
mip_cc_error* errorInfo);
MIP_CC_TelemetryConfiguration_SetHostName
Ustawianie nazwy hosta telemetrii, który będzie zastępować ustawienia wewnętrznej telemetrii
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| hostName (Nazwa hosta) | Nazwa hosta |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Ta właściwość jest ustawiana, gdy aplikacja klienckia używa tego samego składnika telemetrii Aria/1DS i chce, aby jej wewnętrzne ustawienia telemetrii (buforowanie, rejestrowanie, priorytet itp.) używane zamiast domyślnych ustawień 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
Ustawianie zastępowania biblioteki udostępnionej telemetrii
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| nazwa_biblioteki | Nazwa biblioteki DLL, która implementuje interfejs API C SDK Aria/1DS |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Ta właściwość jest ustawiana, gdy klient ma istniejącą telemetrię DLL, która implementuje interfejs API C SDK Aria/1DS, który powinien być używany zamiast 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
Zastępowanie domyślnego stosu telemetrii HTTP własnym klientem
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| httpDelegate | Wystąpienie wywołania zwrotnego HTTP zaimplementowane przez aplikację kliencną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli ta właściwość nie jest ustawiona, składnik telemetrii będzie używać domyślnego stosu HTTP protokołu 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
Zastępowanie domyślnego dyspozycyjnika zadań synchronizacji własnymi klienta
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| taskDispatcherDelegate | Wystąpienie wywoływania menedżera zadań zaimplementowane przez aplikację kliencyjną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Ustawia, czy składnik telemetrii może sprawdzać stan sieci za pomocą polecenia ping w wątku w tle.
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| isCachingEnabled | Czy składnik telemetrii może sprawdzać stan sieci za pomocą polecenia ping w wątku w tle |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:wartość domyślna to "prawda"
mip_cc_result MIP_CC_TelemetryConfiguration_SetIsNetworkDetectionEnabled(
const mip_cc_telemetry_configuration telemetryConfig,
const bool isNetworkDetectionEnabled,
mip_cc_error* errorInfo);
MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled
Ustawia, czy składnik telemetrii może zapisywać pamięci podręczne na dysku
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| isCachingEnabled | Czy składnik telemetrii może zapisywać pamięci podręczne na dysku |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:wartość domyślna to "prawda"
mip_cc_result MIP_CC_TelemetryConfiguration_SetIsLocalCachingEnabled(
const mip_cc_telemetry_configuration telemetryConfig,
const bool isCachingEnabled,
mip_cc_error* errorInfo);
MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled
Ustawia, czy składnik telemetrii może zapisywać dzienniki na dysku
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| isTraceLoggingEnabled | Czy składnik telemetrii może zapisywać dzienniki na dysku |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:wartość domyślna to "prawda"
mip_cc_result MIP_CC_TelemetryConfiguration_SetIsTraceLoggingEnabled(
const mip_cc_telemetry_configuration telemetryConfig,
const bool isTraceLoggingEnabled,
mip_cc_error* errorInfo);
MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut
Ustawia, czy aplikacja/użytkownik zrezygnował z opcjonalnej telemetrii
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| isTelemetryOptedOut | Czy aplikacja/użytkownik zrezygnował z opcjonalnej telemetrii |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:wartość domyślna to "fałsz"
mip_cc_result MIP_CC_TelemetryConfiguration_SetIsTelemetryOptedOut(
const mip_cc_telemetry_configuration telemetryConfig,
const bool isTelemetryOptedOut,
mip_cc_error* errorInfo);
MIP_CC_TelemetryConfiguration_SetCustomSettings
Ustawia niestandardowe ustawienia telemetrii
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| ustawienia niestandardowe | Niestandardowe ustawienia telemetrii |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Maskowanie właściwości telemetrii
Parametry
| Parametr | Opis |
|---|---|
| telemetrykonfigurowa | Konfiguracja telemetrii |
| nazwa_zdarzenia | Nazwa zdarzenia |
| propertyName | Nazwa właściwości |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Zwalnianie zasobów skojarzonych z ustawieniami profilu ochrony
Parametry
| Parametr | Opis |
|---|---|
| profileSettings | Ustawienia profilu ochrony do premiery |
void MIP_CC_ReleaseTelemetryConfiguration(mip_cc_telemetry_configuration telemetryConfig);
MIP_CC_TemplateDescriptor_GetId
Pobiera identyfikator szablonu
Parametry
| Parametr | Opis |
|---|---|
| protectionDescriptor | Descriptor skojarzony z zawartością chronioną |
| templateId | [Dane wyjściowe] Identyfikator szablonu skojarzonego z ochroną |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera rozmiar buforu wymaganego do przechowywania nazwy
Parametry
| Parametr | Opis |
|---|---|
| templateDescriptor | Deskryptor skojarzony z szablonem |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_TemplateDescriptor_GetNameSize(
const mip_cc_template_descriptor templateDescriptor,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_TemplateDescriptor_GetName
Pobiera nazwę szablonu
Parametry
| Parametr | Opis |
|---|---|
| templateDescriptor | Deskryptor skojarzony z szablonem |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość NameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania opisu
Parametry
| Parametr | Opis |
|---|---|
| templateDescriptor | Deskryptor skojarzony z szablonem |
| descriptionSize | [Dane wyjściowe] Rozmiar buforu do przechowywania opisu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_TemplateDescriptor_GetDescriptionSize(
const mip_cc_template_descriptor templateDescriptor,
int64_t* descriptionSize,
mip_cc_error* errorInfo);
MIP_CC_TemplateDescriptor_GetDescription
Gets Template description
Parametry
| Parametr | Opis |
|---|---|
| templateDescriptor | Deskryptor skojarzony z szablonem |
| descriptionBuffer | [Dane wyjściowe] Buforuj opis, do który zostanie skopiowany. |
| descriptionBufferSize | Rozmiar (w liczbie znaków) opisuBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli opisBuffer ma wartość null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualDescriptionSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Zwalnianie zasobów skojarzonych z deskryptorem szablonu
Parametry
| Parametr | Opis |
|---|---|
| templateDescriptor | Deskryptor szablonu do rozsyłania |
void MIP_CC_ReleaseTemplateDescriptor(mip_cc_template_descriptor templateDescriptor);
MIP_CC_ActionResult_GetActions
Uzyskiwanie akcji, które tworzą wynik akcji
Parametry
| Parametr | Opis |
|---|---|
| actionResult | Wynik akcji źródłowej |
| akcje | [Dane wyjściowe] Tablica akcji, pamięć należąca do mip_cc_action_result obiektu |
| liczba | [Dane wyjściowe] Liczba par klucz/wartość |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Pamięć dla "akcji" jest własnością mip_cc_action_result, więc nie powinna być wolny niezależnie
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
Zwalnianie zasobów skojarzonych z wynikiem akcji
Parametry
| Parametr | Opis |
|---|---|
| actionResult | Wynik działania zostanie opublikowany |
void MIP_CC_ReleaseActionResult(mip_cc_action_result actionResult);
MIP_CC_AddContentFooterAction_GetUIElementNameSize
Pobiera rozmiar buforu wymaganego do przechowywania nazwy elementu interfejsu użytkownika akcji "dodaj stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy elementu interfejsu użytkownika (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetUIElementNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentFooterAction_GetUIElementName
Pobiera nazwę elementu interfejsu użytkownika akcji "dodaj stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| nameBuffer | [Dane wyjściowe] Bufor nazwy elementu interfejsu użytkownika zostanie skopiowany do. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Uzyskuje rozmiar buforu wymaganego do przechowywania tekstu akcji "dodaj stopkę zawartości".
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania tekstu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetTextSize(
const mip_cc_action action,
int64_t* textSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentFooterAction_GetText
Pobiera tekst akcji "dodaj stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| textBuffer | [Dane wyjściowe] Buforuj tekst, do który zostanie skopiowany. |
| textBufferSize | Rozmiar (w liczbie znaków) of the textBuffer. |
| actualTextSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość textBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualTextSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania nazwy czcionki akcji "dodaj stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetFontNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentFooterAction_GetFontName
Pobiera nazwę czcionki akcji "dodaj stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę czcionki, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar czcionki liczby całkowitej.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| fontSize | [Dane wyjściowe] Rozmiar czcionki |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetFontSize(
const mip_cc_action action,
int32_t* fontSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentFooterAction_GetFontColorSize
Uzyskuje rozmiar buforu wymaganego do przechowywania koloru czcionki akcji "dodaj stopkę"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| colorSize | [Dane wyjściowe] Rozmiar bufora w celu przechowywania koloru czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetFontColorSize(
const mip_cc_action action,
int64_t* colorSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentFooterAction_GetFontColor
Pobiera kolor czcionki akcji "dodaj stopkę zawartości" (na przykład "#000000")
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| colorBuffer | [Dane wyjściowe] Buforuj kolor czcionki, do który zostanie skopiowany. |
| colorBufferSize | Rozmiar (w liczbie znaków) of the colorBuffer. |
| actualColorSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość colorBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualColorSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera wyrównanie
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| wyrównanie | [Dane wyjściowe] Wyrównanie |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera rozmiar marginesu
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj stopkę zawartości" |
| marginSize | [Dane wyjściowe] Rozmiar marginesu (w mm) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentFooterAction_GetMargin(
const mip_cc_action action,
int32_t* marginSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetUIElementNameSize
Uzyskuje rozmiar buforu wymaganego do przechowywania nazwy elementu interfejsu użytkownika akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy elementu interfejsu użytkownika (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetUIElementNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetUIElementName
Pobiera nazwę elementu interfejsu użytkownika akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| nameBuffer | [Dane wyjściowe] Bufor nazwy elementu interfejsu użytkownika zostanie skopiowany do. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania tekstu akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania tekstu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetTextSize(
const mip_cc_action action,
int64_t* textSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetText
Pobiera tekst akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| textBuffer | [Dane wyjściowe] Buforuj tekst, do który zostanie skopiowany. |
| textBufferSize | Rozmiar (w liczbie znaków) of the textBuffer. |
| actualTextSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość textBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualTextSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania nazwy czcionki akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetFontNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetFontName
Pobiera nazwę czcionki dla akcji "Dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę czcionki, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar czcionki liczby całkowitej.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| fontSize | [Dane wyjściowe] Rozmiar czcionki |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetFontSize(
const mip_cc_action action,
int32_t* fontSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetFontColorSize
Uzyskuje rozmiar bufora wymaganego do przechowywania koloru czcionki akcji "dodaj nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| colorSize | [Dane wyjściowe] Rozmiar bufora w celu przechowywania koloru czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetFontColorSize(
const mip_cc_action action,
int64_t* colorSize,
mip_cc_error* errorInfo);
MIP_CC_AddContentHeaderAction_GetFontColor
Pobiera kolor czcionki akcji "dodaj nagłówek zawartości" (na przykład "#000000")
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| colorBuffer | [Dane wyjściowe] Buforuj kolor czcionki, do który zostanie skopiowany. |
| colorBufferSize | Rozmiar (w liczbie znaków) of the colorBuffer. |
| actualColorSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość colorBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualColorSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera wyrównanie
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| wyrównanie | [Dane wyjściowe] Wyrównanie |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera rozmiar marginesu
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodawanie nagłówka zawartości" |
| marginSize | [Dane wyjściowe] Rozmiar marginesu (w mm) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddContentHeaderAction_GetMargin(
const mip_cc_action action,
int32_t* marginSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetUIElementNameSize
Uzyskuje rozmiar bufora wymaganego do przechowywania nazwy elementu interfejsu użytkownika akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy elementu interfejsu użytkownika (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddWatermarkAction_GetUIElementNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetUIElementName
Pobiera nazwę elementu interfejsu użytkownika akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| nameBuffer | [Dane wyjściowe] Bufor nazwy elementu interfejsu użytkownika zostanie skopiowany do. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera układ znaku wodnego
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| układ | [Dane wyjściowe] Układ znaku wodnego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Uzyskuje rozmiar bufora wymaganego do przechowywania tekstu akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| textSize | [Dane wyjściowe] Rozmiar buforu do przechowywania tekstu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddWatermarkAction_GetTextSize(
const mip_cc_action action,
int64_t* textSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetText
Pobiera tekst akcji "dodawanie znaku wodnego"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| textBuffer | [Dane wyjściowe] Buforuj tekst, do który zostanie skopiowany. |
| textBufferSize | Rozmiar (w liczbie znaków) of the textBuffer. |
| actualTextSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość textBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualTextSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Uzyskuje rozmiar bufora wymaganego do przechowywania nazwy czcionki akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddWatermarkAction_GetFontNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetFontName
Pobiera nazwę czcionki akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę czcionki, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar czcionki liczby całkowitej.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| fontSize | [Dane wyjściowe] Rozmiar czcionki |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddWatermarkAction_GetFontSize(
const mip_cc_action action,
int32_t* fontSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetFontColorSize
Uzyskuje rozmiar bufora wymaganego do przechowywania koloru czcionki akcji "dodaj znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| colorSize | [Dane wyjściowe] Rozmiar bufora w celu przechowywania koloru czcionki (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_AddWatermarkAction_GetFontColorSize(
const mip_cc_action action,
int64_t* colorSize,
mip_cc_error* errorInfo);
MIP_CC_AddWatermarkAction_GetFontColor
Pobiera kolor czcionki akcji "dodaj znak wodny" (na przykład "#000000")
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "dodaj znak wodny" |
| colorBuffer | [Dane wyjściowe] Buforuj kolor czcionki, do który zostanie skopiowany. |
| colorBufferSize | Rozmiar (w liczbie znaków) of the colorBuffer. |
| actualColorSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość colorBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualColorSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Zwalnianie zasobów skojarzonych z etykietą zawartości
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta do premiery |
void MIP_CC_ReleaseContentLabel(mip_cc_content_label contentLabel);
MIP_CC_ContentLabel_GetCreationTime
Pobiera czas po zastosowaniu etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta |
| creationTime | [Dane wyjściowe] Czas, kiedy etykieta została zastosowana do dokumentu (w sekundach od czasu ery) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ContentLabel_GetCreationTime(
const mip_cc_content_label contentLabel,
int64_t* creationTime,
mip_cc_error* errorInfo);
MIP_CC_ContentLabel_GetAssignmentMethod
Pobiera metodę przypisywania etykiet
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta |
| assignmentMethod | [Dane wyjściowe] Metoda przypisywania (np. "standardowa" lub "privileged") |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Pobiera właściwości rozszerzone
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta |
| właściwości | [Dane wyjściowe] Słownik właściwości rozszerzonych, pamięci należącej do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "właściwości" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Określa, czy ochrona została zastosowana przez etykietę.
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta |
| isProtectionAppliedByLabel | [Dane wyjściowe] Jeśli dokument jest chroniony i ta etykieta wyraźnie chroniła go. |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ContentLabel_IsProtectionAppliedFromLabel(
const mip_cc_content_label contentLabel,
bool* isProtectionAppliedByLabel,
mip_cc_error* errorInfo);
MIP_CC_ContentLabel_GetLabel
Pobiera ogólne właściwości etykiety z wystąpienia etykiety zawartości
Parametry
| Parametr | Opis |
|---|---|
| etykieta zawartości | Etykieta |
| etykieta | [Dane wyjściowe] Ogólna etykieta, pamięć należąca do dzwoniącego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "etykieta" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Pobiera rozmiar buforu wymaganego do przechowywania nazwy akcji niestandardowej.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "niestandardowa" |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_CustomAction_GetNameSize(
const mip_cc_action action,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_CustomAction_GetName
Pobiera nazwę akcji niestandardowej.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "niestandardowa" |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera właściwości akcji "niestandardowej".
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "niestandardowa" |
| właściwości | [Dane wyjściowe] Słownik właściwości, pamięć, której właścicielem jest wywołujący |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "właściwości" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Zwalnianie zasobów skojarzonych z etykietą
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta do premiery |
void MIP_CC_ReleaseLabel(mip_cc_label label);
MIP_CC_Label_GetId
Pobiera identyfikator etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| labelId | [Dane wyjściowe] Identyfikator etykiety |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetId(
const mip_cc_label label,
mip_cc_guid* labelId,
mip_cc_error* errorInfo);
MIP_CC_Label_GetNameSize
Pobiera rozmiar buforu wymaganego do przechowywania nazwy
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| nameSize | [Dane wyjściowe] Rozmiar buforu do przechowywania nazwy (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetNameSize(
const mip_cc_label label,
int64_t* nameSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetName
Pobiera nazwę etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| nameBuffer | [Dane wyjściowe] Buforuj nazwę, do która zostanie skopiowana. |
| nameBufferSize | Rozmiar (w liczbie znaków) nazwyBuffer. |
| actualNameSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość nameBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualNameSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania opisu
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| descriptionSize | [Dane wyjściowe] Rozmiar buforu do przechowywania opisu (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetDescriptionSize(
const mip_cc_label label,
int64_t* descriptionSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetDescription
Pobiera opis etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| descriptionBuffer | [Dane wyjściowe] Buforuj opis, do który zostanie skopiowany. |
| descriptionBufferSize | Rozmiar (w liczbie znaków) opisuBuffer. |
| actualDescriptionSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość descriptionBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość ActualDescriptionSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Uzyskuje rozmiar bufora wymaganego do przechowywania koloru
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| colorSize | [Dane wyjściowe] Rozmiar buforu do przechowywania koloru (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetColorSize(
const mip_cc_label label,
int64_t* colorSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetColor
Pobiera kolor etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| colorBuffer | [Dane wyjściowe] Bufor koloru zostanie skopiowany do (w #RRGGBB format). |
| colorBufferSize | Rozmiar (w liczbie znaków) of the colorBuffer. |
| actualColorSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość colorBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualColorSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera poziom wrażliwości etykiety. Wyższa wartość oznacza, że jest bardziej wrażliwa.
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| czułość | [Dane wyjściowe] Charakter |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetSensitivity(
const mip_cc_label label,
int32_t* sensitivity,
mip_cc_error* errorInfo);
MIP_CC_Label_GetTooltipSize
Pobiera rozmiar buforu wymaganego do przechowywania etykietki narzędzia
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| tooltipSize | [Dane wyjściowe] Rozmiar buforu do przechowywania etykietki narzędzia (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetTooltipSize(
const mip_cc_label label,
int64_t* tooltipSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetTooltip
Pobiera etykietkę narzędzia etykiety
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| tooltipBuffer | [Dane wyjściowe] Bufor etykietki narzędzia zostanie skopiowany do. |
| tooltipBufferSize | Rozmiar (w liczbie znaków) etykietki narzędziaBuffer. |
| actualTooltipSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli etykietka narzędziaBuffer ma wartość null lub jest niewystarczająca, zostanie zwrócony MIP_RESULT_ERROR_INSUFFICIENT_BUFFER, a w rozmiarzeTooltipSize zostanie ustawiony minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania etykietki narzędzia autosklasyfikowania
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| tooltipSize | [Dane wyjściowe] Rozmiar buforu do przechowywania etykietki narzędzia (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetAutoTooltipSize(
const mip_cc_label label,
int64_t* tooltipSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetAutoTooltip
Pobiera etykietkę narzędzia autosklasyfikowania etykiet
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| tooltipBuffer | [Dane wyjściowe] Bufor etykietki narzędzia zostanie skopiowany do. |
| tooltipBufferSize | Rozmiar (w liczbie znaków) etykietki narzędziaBuffer. |
| actualTooltipSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli etykietka narzędziaBuffer ma wartość null lub jest niewystarczająca, zostanie zwrócony MIP_RESULT_ERROR_INSUFFICIENT_BUFFER, a w rozmiarzeTooltipSize zostanie ustawiony minimalny wymagany rozmiar buforu.
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
Sprawdza, czy etykieta jest aktywna
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| isActive | [Dane wyjściowe] Określa, czy etykieta jest uznawana za aktywną. |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Można stosować tylko aktywne etykiety. Nie można stosować etykiet dezaktywacji i są one używane tylko do wyświetlania.
mip_cc_result MIP_CC_Label_IsActive(
const mip_cc_label label,
bool* isActive,
mip_cc_error* errorInfo);
MIP_CC_Label_GetParent
Pobiera etykietę nadrzędną, jeśli jest
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| element nadrzędny | [Dane wyjściowe] Etykieta nadrzędna, jeśli jest dowolna, wartość null |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetParent(
const mip_cc_label label,
mip_cc_label* parent,
mip_cc_error* errorInfo);
MIP_CC_Label_GetChildrenSize
Pobiera liczbę etykiet dzieci
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| childrenSize | [Dane wyjściowe] Liczba dzieci |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_Label_GetChildrenSize(
const mip_cc_label label,
int64_t* childrenSize,
mip_cc_error* errorInfo);
MIP_CC_Label_GetChildren
Pobiera etykiety dzieci
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| childrenBuffer | [Dane wyjściowe] Buforuj, do których zostaną skopiowane etykiety dzieci. Etykiety dla dzieci |
| childrenBufferSize | Rozmiar (w liczbie etykiet) dzieckaBuffer. |
| actualSize | [Dane wyjściowe] Liczba etykiet dzieci wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość childrenBuffer jest null lub jest niewystarczająca, zostanie MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zwrócona, a wartość actual SzybkSize zostanie ustawiona na minimalny wymagany rozmiar buforu
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
Pobiera niestandardowe ustawienia etykiety zdefiniowane przez zasady
Parametry
| Parametr | Opis |
|---|---|
| etykieta | Etykieta |
| Ustawienia | [Dane wyjściowe] Słownik ustawień należących do dzwoniącego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "ustawienia" musi zostać zwolniona przez rozmówcę, dzwoniąc do 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
Pobiera metadane akcji "metadane" do usunięcia.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "metadane" |
| metadaneNazwy | [Dane wyjściowe] Key names of metadata to remove, memory owned by caller |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "nazwy metadanych" musi zostać zwolniona przez obiekt wywołujący, dzwoniąc MIP_CC_ReleaseStringList @note Usunięcie metadanych należy wykonać przed dodaniem metadanych.
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
Pobiera metadane akcji "metadane" do dodania
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "metadane" |
| metadane | [Dane wyjściowe] lista wpisów metadanych do dodania, pamięci należącej do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "metadane" musi zostać zwolniona przez dzwoniącego, dzwoniąc MIP_CC_ReleaseDictionary @note Usunięcie metadanych należy wykonać przed dodaniem metadanych.
mip_cc_result MIP_CC_MetadataAction_GetMetadataToAdd(
const mip_cc_action action,
mip_cc_metadata_dictionary* metadata,
mip_cc_error* errorInfo);
MIP_CC_CreateMetadataDictionary
Tworzenie słownika z kluczami/wartościami ciągów
Parametry
| Parametr | Opis |
|---|---|
| wpisy | Tablica wpisów metadanych |
| liczba | Liczba wpisów metadanych |
| słownik | [Dane wyjściowe] Nowo utworzony słownik |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:aby można było mip_cc_dictionary, należy dzwonić do 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
Uzyskiwanie wpisów metadanych, które tworzą słownik
Parametry
| Parametr | Opis |
|---|---|
| słownik | Słownik źródłowy |
| wpisy | [Dane wyjściowe] Tablica wpisów metadanych, pamięć należąca do mip_cc_dictionary obiektu |
| liczba | [Dane wyjściowe] Liczba wpisów metadanych |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Pamięć "wpisów" należy do obiektu mip_cc_dictionary, więc nie powinna być uwolniona niezależnie
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
Zwalnianie zasobów skojarzonych ze słownikiem
Parametry
| Parametr | Opis |
|---|---|
| słownik | Słownik do opublikowanych |
void MIP_CC_ReleaseMetadataDictionary(mip_cc_metadata_dictionary dictionary);
MIP_CC_ReleasePolicyHandler
Zwalnianie zasobów skojarzonych z programem obsługi zasad
Parametry
| Parametr | Opis |
|---|---|
| program obsługi | Obsługa zasad do wydania |
void MIP_CC_ReleasePolicyHandler(mip_cc_policy_handler handler);
MIP_CC_PolicyHandler_GetSensitivityLabel
Pobiera bieżącą etykietę dokumentu
Parametry
| Parametr | Opis |
|---|---|
| program obsługi | Obsługa zasad |
| documentState | Stan dokumentu |
| kontekst | Kontekst aplikacji nieprzezroczystie przesyłany dalej do dowolnych wywołań |
| etykieta zawartości | Etykieta obecnie zastosowana do dokumentu |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
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
Wykonuje reguły zasad na podstawie podanego stanu i określa odpowiednie akcje.
Parametry
| Parametr | Opis |
|---|---|
| program obsługi | Obsługa zasad |
| documentState | Stan dokumentu |
| applicationState | Stan akcji aplikacji |
| kontekst | Kontekst aplikacji nieprzezroczystie przesyłany dalej do dowolnych wywołań |
| actionResult | [Dane wyjściowe] Akcje, które powinny być podejmowane przez aplikację, pamięć należącą do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "actionResult" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Wywoływane przez aplikację po zastosowaniu akcji obliczanych i danych zatwierdzona na dysku
Parametry
| Parametr | Opis |
|---|---|
| program obsługi | Obsługa zasad |
| documentState | Stan dokumentu |
| applicationState | Stan akcji aplikacji |
| kontekst | Kontekst aplikacji nieprzezroczystie przesyłany dalej do dowolnych wywołań |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:w celu przekazania pełnych danych inspekcji etykiet konieczne jest wywołanie tej funkcji.
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
Uzyskuje rozmiar bufora wymaganego do przechowywania adresu URL szyfrowania dwukluczowych.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "Ochrona za pomocą zasad adhocowych z podwójnym klawiszem" |
| urlSize | [Dane wyjściowe] Rozmiar buforu do przechowywania adresu URL (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrlSize(
const mip_cc_action action,
int64_t* urlSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectAdhocDkAction_GetDoubleKeyEncryptionUrl
Pobiera adres URL szyfrowania z podwójnym kluczem
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "Ochrona za pomocą zasad adhocowych z podwójnym klawiszem" |
| urlBuffer | [Dane wyjściowe] Buforuj adres URL, do który zostanie skopiowany. |
| urlBufferSize | Rozmiar (w liczbie znaków) okna urlBuffer. |
| actualUrlSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość urlBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualUrlSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Uzyskuje rozmiar bufora wymaganego do przechowywania adresu URL szyfrowania dwukluczowych.
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "protect by dp not forward policy with double key" (ochrona za pomocą zasady dp not forward za pomocą podwójnej kluczowych akcji) |
| urlSize | [Dane wyjściowe] Rozmiar buforu do przechowywania adresu URL (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrlSize(
const mip_cc_action action,
int64_t* urlSize,
mip_cc_error* errorInfo);
MIP_CC_ProtectDoNotForwardDkAction_GetDoubleKeyEncryptionUrl
Pobiera adres URL szyfrowania z podwójnym kluczem
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "protect by dp not forward policy with double key" (ochrona za pomocą zasady dp not forward za pomocą podwójnej kluczowych akcji) |
| urlBuffer | [Dane wyjściowe] Buforuj adres URL, do który zostanie skopiowany. |
| urlBufferSize | Rozmiar (w liczbie znaków) okna urlBuffer. |
| actualUrlSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość urlBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualUrlSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera do usunięcia nazwy elementów interfejsu użytkownika akcji "usuń stopkę zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "usuń stopkę zawartości" |
| nazwy | [Dane wyjściowe] Nazwy elementów interfejsu użytkownika do usunięcia, pamięci należącej do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "nazwiska" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Pobiera do usunięcia nazwy elementów interfejsu użytkownika akcji "usuń nagłówek zawartości"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "usuń nagłówek zawartości" |
| nazwy | [Dane wyjściowe] Nazwy elementów interfejsu użytkownika do usunięcia, pamięci należącej do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "nazwiska" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Pobiera do usunięcia nazwy elementów interfejsu użytkownika akcji "usuń znak wodny"
Parametry
| Parametr | Opis |
|---|---|
| akcja | Akcja "usuwanie stopki znaku wodnego" |
| nazwy | [Dane wyjściowe] Nazwy elementów interfejsu użytkownika do usunięcia, pamięci należącej do wywołującego |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Zmienna "nazwiska" musi zostać zwolniona przez dzwoniącego, dzwoniąc do 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
Zwalnianie zasobów skojarzonych z typem wrażliwości
Parametry
| Parametr | Opis |
|---|---|
| sensitivityType (typ charakter) | Typ wrażliwości do premiery |
void MIP_CC_ReleaseSensitivityType(mip_cc_sensitivity_type sensitivityType);
MIP_CC_SensitivityType_GetRulePackageIdSize
Uzyskuje rozmiar bufora wymaganego do przechowywania identyfikatora pakietu reguł typu wrażliwości.
Parametry
| Parametr | Opis |
|---|---|
| sensitivityType (typ charakter) | Typ wrażliwości |
| idSize | [Dane wyjściowe] Rozmiar buforu do przechowywania identyfikatora pakietu reguł (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_SensitivityType_GetRulePackageIdSize(
const mip_cc_sensitivity_type sensitivityType,
int64_t* idSize,
mip_cc_error* errorInfo);
MIP_CC_SensitivityType_GetRulePackageId
Pobiera identyfikator pakietu reguł typu wrażliwości.
Parametry
| Parametr | Opis |
|---|---|
| sensitivityType (typ charakter) | Typ wrażliwości |
| idBuffer | [Dane wyjściowe] Buforuj identyfikator, do który zostanie skopiowany. |
| idBufferSize | Rozmiar (w liczbie znaków) użytkownika idBuffer. |
| actualIdSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość idBuffer jest null lub jest niewystarczająca, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER zostanie zwrócona, a wartość actualIdSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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
Pobiera rozmiar buforu wymaganego do przechowywania pakietu reguł typu wrażliwości.
Parametry
| Parametr | Opis |
|---|---|
| sensitivityType (typ charakter) | Typ wrażliwości |
| rulePackageSize | [Dane wyjściowe] Rozmiar buforu do przechowywania pakietu reguł (w liczbie znaków) |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
mip_cc_result MIP_CC_SensitivityType_GetRulePackageSize(
const mip_cc_sensitivity_type sensitivityType,
int64_t* rulePackageSize,
mip_cc_error* errorInfo);
MIP_CC_SensitivityType_GetRulePackage
Pobiera pakiet reguł typu wrażliwości
Parametry
| Parametr | Opis |
|---|---|
| sensitivityType (typ charakter) | Typ wrażliwości |
| rulePackageBuffer | [Dane wyjściowe] Bufor pakietu reguł zostanie skopiowany do. |
| rulePackageBufferSize | Rozmiar (w liczbie znaków) regułyPackageBuffer. |
| actualRulePackageSize | [Dane wyjściowe] Liczba znaków wpisanych w buforze |
| errorInfo | [Dane wyjściowe] (Opcjonalnie) Informacje o niepowodzeniu, jeśli wynikiem operacji jest błąd |
Return: Result code indicating success or failure
Uwaga:Jeśli wartość rulePackageBuffer jest null lub jest niewystarczająca, zostanie zwrócona wartość MIP_RESULT_ERROR_INSUFFICIENT_BUFFER, a wartość actualRulePackageSize zostanie ustawiona na minimalny wymagany rozmiar buforu.
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);