JagPDF
Prev Up Home Next

4.4.  Functions

Function create_file()
Function create_profile()
Function create_profile_from_file()
Function create_profile_from_string()
Function create_stream()
Function version()
[py]   create_file(file_path [, profile])
[c++]  Document create_file(Char const* file_path, Profile profile=Profile());
[c]    jag_Document jag_create_file(jag_Char const* file_path, jag_Profile profile);
[java] Document create_file(String file_path [, Profile profile]);
Effect: Creates a PDF document which will be written to a file. The retrieved document instance is reference counted.

Parameters:

file_path

destination file

profile

profile to be used

[py]   create_profile()
[c++]  Profile create_profile();
[c]    jag_Profile jag_create_profile();
[java] Profile create_profile();
Effect: Creates a default profile. The retrieved profile instance is reference counted.

See: section Profile.

[py]   create_profile_from_file(fname)
[c++]  Profile create_profile_from_file(Char const* fname);
[c]    jag_Profile jag_create_profile_from_file(jag_Char const* fname);
[java] Profile create_profile_from_file(String fname);
Effect: Creates a profile from a file. The retrieved profile instance is reference counted.

See: section Profile.

[py]   create_profile_from_string(str)
[c++]  Profile create_profile_from_string(Char const* str);
[c]    jag_Profile jag_create_profile_from_string(jag_Char const* str);
[java] Profile create_profile_from_string(String str);
Effect: Creates a profile from a string. The retrieved profile instance is reference counted.

See: section Profile.

[py]   create_stream(stream [, profile])
[c++]  Document create_stream(StreamOut const* stream, Profile profile=Profile());
[c]    jag_Document jag_create_stream(jag_streamout const* stream, jag_Profile profile);
[java] Document create_stream(StreamOut[] stream [, Profile profile]);
Effect: Creates a PDF document which will be written to a stream. The retrieved profile instance is reference counted.

Parameters:

stream

destination stream

profile

profile to be used

See: section Custom Output Streams.

[py]   version()
[c++]  UInt version();
[c]    jag_UInt jag_version();
[java] long version();
Effect:

Retrieves JagPDF version. The JagPDF version triplet is encoded into a single value as follows:

  • bits 0-7 - patch
  • bits 8-15 - minor
  • bits 16-23 - major

Not to be confused with version().

See: section JagPDF Versioning

Prev Up Home Next