StoreCustomDataFromString
Propriedades do documento
Descrição
Salva custom data no PDF sob um nome de chave Esses dados podem depois ser recuperados com as funções RetrieveCustomDataToString, RetrieveCustomDataToVariant ou RetrieveCustomDataToFile O tipo de armazenamento (string, stream ou compressed stream) e a localização (Document Information Dictionary ou Document Catalog) podem ser definidos Se a localização for o Document Catalog, qualquer tipo de armazenamento pode ser usado, mas a chave precisa ter um prefixo especial atribuído a você pela Adobe Se a localização for o Document Information Dictionary, qualquer chave além das chaves padrão pode ser usada, mas apenas strings podem ser usadas
Quando Location é 2, chaves de sistema do catálogo ficam reservadas e retornam 0 em vez de serem sobrescritas. O conjunto reservado inclui OutputIntents, gerenciado pelos fluxos de PDF/A e de saída de cores.
Sintaxe
Delphi
Function TPDFlib.StoreCustomDataFromString(Const Key, NewValue: AnsiString; Location, Options: Integer): Integer;DLL
int DLStoreCustomDataFromString(int InstanceID, const char * Key, const char * NewValue, int Location, int Options);Parâmetros
| Key | A chave sob a qual os dados serão armazenados Se a localização for o Document Information Dictionary, a chave não pode ser "Author", "Title", "Subject", "Keywords", "Creator" ou "Producer" Qualquer outra chave pode ser usada, mas as chaves devem ser escolhidas com cuidado para fazer sentido ao usuário Se a localização for o Document Catalog, a chave precisa ter um prefixo especial atribuído a você pela Adobe para evitar conflitos com outros softwares |
|---|---|
| NewValue | The new value for the data |
| Location | 1 = Armazenar os dados no Document Information Dictionary 2 = Armazenar os dados no Document Catalog |
| Options | 0 = Armazenar os dados como string (única opção disponível quando o local é o Document Information Dictionary) 1 = Armazenar os dados em um stream 2 = Armazenar os dados em um stream comprimido |
Valores retornados
| 0 | Os dados não puderam ser armazenados porque o nome da chave era um nome reservado |
|---|---|
| 1 | Os dados foram armazenados com sucesso |