StoreCustomDataFromString
文書プロパティ
説明
キー名の下でカスタムデータを PDF に保存します。このデータは後で RetrieveCustomDataToString、RetrieveCustomDataToVariant、または RetrieveCustomDataToFile 関数を使用して取得できます。格納タイプ（文字列、ストリーム、圧縮ストリーム）と場所（Document Information Dictionary または Document Catalog）を設定できます。場所が Document Catalog の場合は任意の格納タイプを使用できますが、キーには Adobe から割り当てられた特別なプレフィックスが必要です。場所が Document Information Dictionary の場合は標準キー以外の任意のキーを使用できますが、使用できるのは文字列だけです
Location が 2 の場合、Catalog のシステムキーは予約されており、上書きされずに 0 を返します。予約セットには PDF/A およびカラー出力ワークフローで管理される OutputIntents が含まれます
構文
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);パラメータ
| Key | データを格納するキーです。場所がドキュメント情報辞書の場合、キーに "Author"、"Title"、"Subject"、"Keywords"、"Creator"、"Producer" は使用できません。他のキーは使用できますが、ユーザーにとって意味が分かるよう慎重に選択する必要があります。場所がドキュメントカタログの場合、他のソフトウェアとの競合を避けるため、キーには Adobe から割り当てられた特別な接頭辞が必要です |
|---|---|
| NewValue | データの新しい値 |
| Location | 1 = データを Document Information Dictionary に格納 2 = データを Document Catalog に格納 |
| Options | 0 = データを文字列として保存する（場所が文書情報辞書の場合に利用できる唯一のオプション） 1 = データをストリームに保存する 2 = データを圧縮ストリームに保存する |
戻り値
| 0 | キー名が予約名だったため、データを格納できませんでした |
|---|---|
| 1 | データが正常に格納されました |