|  |  |  | GSF Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
GsfInfileMSOle; GsfInfile * gsf_infile_msole_new (GsfInput *source,GError **err); gboolean gsf_infile_msole_get_class_id (GsfInfileMSOle const *ole,guint8 *res); GsfOutfileMSOle; GsfOutfile * gsf_outfile_msole_new (GsfOutput *sink); GsfOutfile * gsf_outfile_msole_new_full (GsfOutput *sink,guint bb_size,guint sb_size); gboolean gsf_outfile_msole_set_class_id (GsfOutfileMSOle *ole,guint8 const *clsid); GError * gsf_msole_metadata_read (GsfInput *in,GsfDocMetaData *accum); gboolean gsf_msole_metadata_write (GsfOutput *out,GsfDocMetaData const *meta_data,gboolean doc_not_component); GIConv gsf_msole_iconv_open_codepages_for_export (int codepage_to,char const *from); GIConv gsf_msole_iconv_open_codepage_for_import (char const *to,int codepage); GIConv gsf_msole_iconv_open_for_export (void); GIConv gsf_msole_iconv_open_codepage_for_export (int codepage_to); GIConv gsf_msole_iconv_open_for_import (int codepage); int gsf_msole_iconv_win_codepage (void); guint gsf_msole_codepage_to_lid (int codepage); int gsf_msole_lid_to_codepage (guint lid); gchar * gsf_msole_lid_to_codepage_str (guint lid); guint gsf_msole_lid_for_language (char const *lang); char const * gsf_msole_language_for_lid (guint lid); GByteArray * gsf_msole_inflate (GsfInput *input,gsf_off_t offset);
GObject +----GsfInput +----GsfInfile +----GsfInfileMSOle
GObject +----GsfOutput +----GsfOutfile +----GsfOutfileMSOle
"big-block-size" guint : Read / Write / Construct Only "sink" GsfOutput* : Read / Write / Construct Only "small-block-size" guint : Read / Write / Construct Only
GsfInfile * gsf_infile_msole_new (GsfInput *source,GError **err);
Opens the root directory of an MS OLE file.
source.
| 
 | GsfInput | 
| 
 | optional place to store an error | 
| Returns : | the new ole file handler | 
gboolean gsf_infile_msole_get_class_id (GsfInfileMSOle const *ole,guint8 *res);
Retrieves the 16 byte indentifier (often a GUID in MS Windows apps)
stored within the directory associated with ole and stores it in res.
| 
 | a GsfInfileMSOle | 
| 
 | 16 byte identifier (often a GUID in MS Windows apps) | 
| Returns : | TRUE on success | 
GsfOutfile *        gsf_outfile_msole_new               (GsfOutput *sink);
Creates the root directory of an MS OLE file and manages the addition of children.
sink.
| 
 | a GsfOutput to hold the OLE2 file | 
| Returns : | the new ole file handler. | 
GsfOutfile * gsf_outfile_msole_new_full (GsfOutput *sink,guint bb_size,guint sb_size);
Creates the root directory of an MS OLE file and manages the addition of children.
sink.
| 
 | a GsfOutput to hold the OLE2 file. | 
| 
 | size of large blocks. | 
| 
 | size of small blocks. | 
| Returns : | the new ole file handler. | 
gboolean gsf_outfile_msole_set_class_id (GsfOutfileMSOle *ole,guint8 const *clsid);
Write clsid to the directory associated with ole.
| 
 | a GsfOutfileMSOle | 
| 
 | Identifier (often a GUID in MS Windows apps). [array fixed-size=16] | 
| Returns : | TRUEon success. | 
GError * gsf_msole_metadata_read (GsfInput *in,GsfDocMetaData *accum);
gsf_msole_metadata_read is deprecated and should not be used in newly-written code. 1.14.24, use gsf_doc_meta_data_read_from_msole
Read a stream formated as a set of MS OLE properties from in and store the
results in accum.
| 
 | GsfInput | 
| 
 | GsfDocMetaData | 
| Returns : | A GError if there was an error. [transfer full] | 
gboolean gsf_msole_metadata_write (GsfOutput *out,GsfDocMetaData const *meta_data,gboolean doc_not_component);
gsf_msole_metadata_write is deprecated and should not be used in newly-written code. 1.14.24, use gsf_doc_meta_data_write_to_msole
| 
 | GsfOutput | 
| 
 | GsfDocMetaData | 
| 
 | a kludge to differentiate DocumentSummary from Summary | 
| Returns : | TRUEon success; | 
GIConv gsf_msole_iconv_open_codepages_for_export (int codepage_to,char const *from);
NOTE: skipped since GIConv is not exported to introspection.
| 
 | the target code page. | 
| 
 | the source encoding. | 
| Returns : | an iconv converter to go from utf8 -> to our best guess at a useful windows codepage. | 
GIConv gsf_msole_iconv_open_codepage_for_import (char const *to,int codepage);
NOTE: skipped since GIConv is not exported to introspection.
| 
 | the target encoding. | 
| 
 | the source code page. | 
| Returns : | an iconv converter for codepage-> utf8. | 
GIConv              gsf_msole_iconv_open_for_export     (void);
NOTE: skipped since GIConv is not exported to introspection.
| Returns : | an iconv convert to go from utf8 -> to our best guess at a useful windows codepage. | 
GIConv              gsf_msole_iconv_open_codepage_for_export
                                                        (int codepage_to);
NOTE: skipped since GIConv is not exported to introspection.
| 
 | the target code page. | 
| Returns : | an iconv converter to go from utf8 -> to our best guess at a useful windows codepage. | 
GIConv              gsf_msole_iconv_open_for_import     (int codepage);
NOTE: skipped since GIConv is not exported to introspection.
| 
 | the source code page. | 
| Returns : | an iconv converter for single byte encodings codepage-> utf8.
Attempt to handle the semantics of a specification for multibyte encodings
since this is only supposed to be used for single bytes. | 
int                 gsf_msole_iconv_win_codepage        (void);
| Returns : | our best guess at the applicable windows code page based on an environment variable or the current locale. | 
int                 gsf_msole_lid_to_codepage           (guint lid);
| 
 | numerical language id | 
| Returns : | our best guess at the codepage for the given language id | 
gchar *             gsf_msole_lid_to_codepage_str       (guint lid);
| 
 | numerical language id | 
| Returns : | the Iconv codepage string for the given LID. [transfer full] | 
guint               gsf_msole_lid_for_language          (char const *lang);
| 
 | Language id, i.e., locale name. [allow-none] | 
| Returns : | the LID (Language Identifier) for the input language.
If lang is NULL, return 0x0400 ("-none-"), and not 0x0000 ("no proofing") | 
char const *        gsf_msole_language_for_lid          (guint lid);
| 
 | numerical language id | 
| Returns : | the xx_YY style string (can be just xx or xxx) for the given LID. If the LID is not found, is set to 0x0400, or is set to 0x0000, will return "-none-". [transfer none] | 
GByteArray * gsf_msole_inflate (GsfInput *input,gsf_off_t offset);
Decompresses an LZ compressed stream.
| 
 | stream to read from | 
| 
 | offset into it for start byte of compresse stream | 
| Returns : | A GByteArray that the caller is responsible for freeing. [transfer full] | 
"big-block-size" property"big-block-size" guint : Read / Write / Construct Only
The size of the OLE's big blocks.
Allowed values: [128,4096]
Default value: 512
"small-block-size" property"small-block-size" guint : Read / Write / Construct Only
The size of the OLE's small blocks.
Allowed values: [8,4096]
Default value: 64