Previous Next JavaScript must be enabled to correctly display this content

Viewer Options

Options are parameters affecting the behavior of the Viewer. These options are available to the developer when using Viewer.

All SCCID values are VTDWORDs (4 bytes long).

Character Mapping

The following character mappings are used.

SCCID_DEFAULTINPUTCHARSET

This option is used in cases where Oracle Outside In cannot determine the character set used to encode the text of an input file. When all other means of determining the file’s character set are exhausted, Oracle Outside In will assume that an input document is encoded in the character set specified by this option. This is most often used when reading plain-text files, but may also be used when reading HTML or PDF files. The possible character sets are listed in charsets.h.

When “extended test for text” is enabled (see SCCID_FIFLAGS), this option will still apply to plain-text input files that are not identified as EBCDIC or Unicode.

This option supersedes the SCCOPT_FALLBACKFORMAT option for selecting the character set assumed for plain-text files. For backwards compatibility, use of deprecated character-set -related values is still currently supported for SCCOPT_FALLBACKFORMAT, though internally such values will be translated into equivalent values for the SCCOPT_DEFAULTINPUTCHARSET. As a result, if an application were to set both options, the last such value set for either option will be the value that takes effect.

Scope

Global

Data Type

VTDWORD

Default

Data

The data types are listed in charsets.h.

SCCID_UNMAPPABLECHAR

When the Oracle Outside In Viewer Technology is displaying a character and cannot find that character in any font on the system, it will display a replacement character. This value is the Unicode value for this character. The default value for this character is 0x002a “*”.

Scope

Local

Data Type

VTWORD

Data

The Unicode value for the character to use.

Default

Input Handling

The following sections pertain to input handling.

SCCID_FALLBACKFORMAT

This option controls how files are handled when their specific application type cannot be determined. This normally affects all plain-text files, because plain-text files are generally identified by process of elimination, for example, when a file isn’t identified as having been created by a known application, it is treated as a plain-text file.

Note: A number of values that were formerly allowed for this option have been deprecated. Specifically, the values that selected specific plain-text character sets are no longer to be used. Instead, applications should use the SCCID_DEFAULTINPUTCHARSET option for such functionality.

Scope

Global

Data Type

VTDWORD

Data

The high VTWORD of this value is reserved and should be set to 0, and the low VTWORD must have one of the following values:

Default

SCCID_FIFLAGS

This option affects how an input file’s internal format (application type) is identified when the file is first opened by the Oracle Outside In technology. When the extended test flag is in effect, and an input file is identified as being either 7-bit ASCII, EBCDIC, or Unicode, the file’s contents will be interpreted as such by the viewing process.

The extended test is optional because it requires extra processing and cannot guarantee complete accuracy (which would require the inspection of every single byte in a file to eliminate false positives.)

Scope

Global

Data Type

VTDWORD

Data

One of the following values:

Default

SCCID_FORMATFLAGS

This option allows the developer to set flags that span multiple Oracle Outside In products.

Scope

Local

Data Type

VTDWORD

Data

Default

0: All flags turned off

SCCID_SYSTEMFLAGS

This option controls a number of miscellaneous interactions between the developer and the Outside In Technology.

Handle Type

VTHDOC

Scope

Local

Data Type

VTDWORD

Data

Default

0

SCCID_LOTUSNOTESDIRECTORY

This option allows the developer to specify the location of a Lotus Notes or Domino installation for use by the NSF filter. A valid Lotus installation directory must contain the file nnotes.dll.

Handle Types

NULL

Scope

Global

Data Type

VTLPBYTE

Data

A path to the Lotus Notes directory.

Default

If this option isn’t set, then OIT will first attempt to load the Lotus library according to the operating system’s PATH environment variable, and then attempt to find and load the Lotus library as indicated in HKEY_CLASSES_ROOT\Notes.Link.

SCCID_PARSEXMPMETADATA

Adobe’s Extensible Metadata Platform (XMP) is a labeling technology that allows you to embed data about a file, known as metadata, into the file itself. This option enables parsing of the XMP data into normal OIT document properties. Enabling this option may cause the loss of some regular data in premium graphics filters (such as Postscript), but won’t affect most formats (such as PDF).

Scope

Local

Data Type

VTBOOL

Data

Default

FALSE

SCCID_PDF_FILTER_MAX_EMBEDDED_OBJECTS

PDF files sometimes have a very large number of embedded objects. This option allows the user to limit the number of embedded objects that are produced in a PDF file. Setting this option to 0 means to produce an unlimited amount of embedded objects.

Scope

Local

Data Type

VTDWORD

Data

The maximum number of embedded objects to produce in PDF output.

Default

0

SCCID_PDF_FILTER_MAX_VECTOR_PATHS

PDF files sometimes have a very large number of vector paths. This option allows the user to limit the number of vector paths that are produced in a PDF file. Setting this option to 0 means to produce an unlimited amount of vector paths.

Scope

Local

Data Type

VTDWORD

Data

The maximum number of vector paths to produce in PDF output.

Default

0

SCCID_PDF_FILTER_REORDER_BIDI

This option controls whether or not the PDF filter will attempt to reorder bidirectional text runs so that the output is in standard logical order as used by the Unicode 2.0 and later specification. This additional processing will result in slower filter performance according to the amount of bidirectional data in the file.

Scope

Global

Data Type

VTDWORD

Data

Default

SCCUT_FILTER_STANDARD_BIDI

SCCID_PDF_FILTER_WORD_DELIM_FRACTION

This option controls the spacing threshold in PDF input documents. Most PDF documents do not have an explicit character denoting a word break. The PDF filter calculates the distance between two character to determine if they are part of the same word or if there should be a word break inserted. The space between characters is compared to the length of the space character in the current font multiplied by this fraction. If the space between characters is larger, then a word break character is inserted into the text stream. Otherwise, the characters are considered to be part of the same word and no word break is inserted.

Scope

Local

Data Type

VTFLOAT

Data

A fraction representing the percentage of the space character used to trigger a word break. Valid values are 0<value<=2.

Default

0.85

SCCID_TIMEZONE

This option allows the user to define an offset to GMT that will be applied during date formatting, allowing date values to be displayed in a selectable time zone. This option affects the formatting of numbers that have been defined as date values. This option will not affect dates that are stored as text.

Note: Daylight savings is not supported. The sent time in msg files when viewed in Outlook can be an hour different from the time sent when an image of the msg file is created.

Scope

Global

Data Type

VTLONG

Data

Integer parameter from -96 to 96, representing 15-minute offsets from GMT. To query the operating system for the time zone set on the machine, specify SCC_TIMEZONE_USENATIVE.

Default

SCCID_HTML_COND_COMMENT_MODE

Some HTML includes a special type of comment that will be read by particular versions of browsers or other products. This option allows you to control which of those comments are included in the output.

Handle Type

VTHDOC

Scope

Local

Data Type

VTDWORD

Data

One or more of the following values OR-ed together:

Default

HTML_COND_COMMENT_NONE

Compression

The following information pertains to compression.

SCCID_FILTERJPG

This option can disable access to any files using JPEG compression, such as JPG graphic files or TIFF files using JPEG compression, or files with embedded JPEG graphics. Attempts to read such files when this option is enabled will fail and return the error SCCERR_UNSUPPORTEDCOMPRESSION if the entire file is JPEG compressed, and grey boxes for embedded JPEG-compressed graphics Unlike many other options, this option must be set programmatically, as it is not stored or read on startup.

The following is a list of file types affected when this option is disabled:

Scope

Global

Data Type

VTDWORD

Data

Default

SCCVW_FILTER_JPG_ENABLED

SCCID_FILTERLZW

This option can disable access to any files using Lempel-Ziv-Welch (LZW) compression, such as .GIF files, .ZIP files or self-extracting archive (.EXE) files containing “shrunk” files. Attempts to read such files when this option is enabled will fail and return the error SCCERR_UNSUPPORTEDCOMPRESSION if the entire file is LZW compressed, and grey boxes for embedded LZW-compressed graphics. Unlike many other options, this option must be set programmatically, as it is not stored or read on startup.

The following is a list of file types affected when this option is disabled:

Scope

Global

Data Type

VTDWORD

Data

Default

SCCVW_FILTER_LZW_ENABLED

Spreadsheet and Database File Rendering

The following information pertains to spreadsheets and database file rendering.

SCCID_DBCLIPBOARD

This option controls the format the database data takes when copied to the clipboard.

Data Type

VTDWORD

Data

One of the following values:

SCCID_DBDRAFTMODE

If this option is TRUE, the display of a database includes a limited set of formatting information. If FALSE, the display includes all supported formatting.

Data Type

VTBOOL

Default

FALSE

SCCID_DBFIELDNAMESTOCLIP

If this option is TRUE, field headings will be copied to the clipboard along with the data.

Data Type

VTBOOL

Default

TRUE

SCCID_DBPRINTFITTOPAGE

This option scales a spreadsheet file to a certain percent or to a page width or height. However, in an effort to preserve readability after scaling, the Viewer Technology will not shrink a database document to under approximately one-third of its original size.

It should be noted that when this option is set to SCCVW_DBPRINTFITMODE_NOMAP, the pages of the database file are printed down first and then across.

Note: Any margins applied as a result of settings for the SCCOPT_DEFAULTPRINTMARGINS option will be included in any scaling that is applied to the viewed image as a result of settings for this option.

Data Type

VTDWORD

Data

One of the following values:

Default

SCCVW_DBPRINTFITMODE_FITTOPAGES

SCCID_DBPRINTGRIDLINES

If this option is TRUE, a dotted grid is printed.

Data Type

VTBOOL

SCCID_DBPRINTHEADINGS

If this option is TRUE, field headings will be printed along with the data.

Data Type

VTBOOL

SCCID_DBSHOWGRIDLINES

If this option is TRUE, a dotted grid is displayed between fields.

Data Type

VTBOOL

SCCID_SSCLIPBOARD

This option controls the format the spreadsheet data takes when copied to the clipboard.

Data Type

VTDWORD

Data

One of the following values:

SCCID_SSDRAFTMODE

If this option is TRUE, the display of a spreadsheet includes a limited set of formatting information. If FALSE, the display includes all supported formatting.

Data Type

VTBOOL

SCCID_SSPRINTDIRECTION

This option controls the pattern in which the pages are printed, either across first and then down, or down first and then across.

This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and print direction is specified in the input document.

Data Type

VTDWORD

Data

One of the following values:

Default

SCCVW_SSPRINTDIRECTION_DOWN

SCCID_SSPRINTFITTOPAGE

This option requests that the spreadsheet file be fit to one page.

Note: Any margins applied as a result of settings for the SCCID_DEFAULTPRINTMARGINS option will be included in any scaling that is applied to the output image as a result of settings for this option.

This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and fitting the page to the printer’s image limits is specified in the input document.

Data Type

VTDWORD

Data

One of the following values:

Default

SCCID_SSPRINTGRIDLINES

If this option is TRUE, a dotted grid is printed between cells.

This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and printing grid lines between cells is specified in the input document.

Data Type

VTBOOL

SCCID_SSPRINTHEADINGS

If this option is TRUE, row and column headings will be printed along with the data.

This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and printing column and row headers is specified in the input document.

Data Type

VTBOOL

SCCID_SSPRINTSCALEPERCENT

This option will scale spreadsheet pages by the percentage specified. The option has no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_SCALE.

This option must take a value between 1 and 100. If any value outside of this range is used, the option will be ignored.

Data Type

VTDWORD

SCCID_SSPRINTSCALEXHIGH

This option will fit the spreadsheet image to the number of vertical pages specified. The setting for this option will have no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_FITTOPAGES.

Data Type

VTDWORD

SCCID_SSPRINTSCALEXWIDE

This option will fit the spreadsheet image to the number of horizontal pages specified. The setting for this option will have no effect unless the SCCID_SSPRINTFITTOPAGE option is set to SCCVW_SSPRINTFITMODE_FITTOPAGES.

Data Type

VTDWORD

SCCID_FILTERNOBLANK

If this option is TRUE, blank spreadsheet pages will not be produced when printing a file or rendering it with the SCCVW_DRAWPAGE message.

Data Type

VTBOOL

SCCID_SSSHOWGRIDLINES

If this option is TRUE, a dotted grid is displayed between cells.

Data Type

VTBOOL

SCCID_SSSHOWHIDDENCELLS

This option lets you determine whether or not to show hidden rows or columns when rendering spreadsheets. This is a BOOLEAN option that will leave the data hidden when it is FALSE, and show all hidden rows and columns when it is TRUE, displayed using the default row width or default column height.

Data Type

VTBOOL

Default

FALSE

Graphics File Rendering

The following information pertains to graphics file rendering.

SCCID_ANTIALIAS

This option determines the way the viewer stretches bitmaps. Antialiased bitmaps may appear smoother and can be easier to read, but rendering when this option is set will require additional processing time.

Data Type

VTDWORD

Data

One of the following values:

SCCID_BMPDITHER

This option tells the bitmap display engine to use a dithering algorithm on bitmaps with higher color resolution than the screen in order to get better color display. It can have the value SCCVW_DITHER_ON or SCCVW_DITHER_OFF.

Data Type

VTBOOL

SCCID_BMPDITHERAVAILABLE

This option is a read only option that indicates the bitmap display engine’s ability to dither the current bitmap. For instance dithering is not possible or necessary for a 16-color bitmap on a 256-color display, but it is possible for a 256-color bitmap on a 16-color display.

Data Type

VTBOOL

SCCID_BMPFITMODE

This option sets the way the bitmap display engine stretches or shrinks a bitmap in relation to the size of the view window.

Data Type

VTDWORD

Data

One of the following values:

SCCID_BMPPRINTASPECT

This option indicates how the bitmap will be stretched when printed.

Data Type

VTDWORD

Data

One of the following values:

BMPPrintAspect

The option indicates how the image will be stretched when printed. It can be one of the following values:

Invalid values will be reset to the last set value.

Type

Short

Default

SCCVW_PRINTASPECT_SCALE

Related to

SCCID_BMPPRINTASPECT (Outside In Viewer)

SCCID_BMPPRINTBORDER

If set to TRUE, a 1-pixel border will be printed around bitmaps.

Data Type

VTBOOL

SCCID_BMPROTATION

This option indicates how bitmaps should be rotated.

Data Type

VTDWORD

Data

One of the following values:

These rotations are absolute from the initial state of the graphic.

SCCID_BMPZOOM

This option indicates the X and Y ratios used to stretch/shrink the original image. For instance, setting the X ratio to 1 and the Y ratio to 2 displays the image pixel for pixel horizontally, but two display pixels for every one-bitmap pixel in the vertical direction.

Data Type

SCCVWIMAGEZOOM structure

SCCVWIMAGEZOOM Structure

This structure is used in the SCCID_BMPZOOM and SCCID_VECZOOM options.

SCCVWIMAGEZOOM is a C data structure defined in sccvw.h as follows.

typedef struct
   {
   VTDWORD   dwXNu;
   VTDWORD   dwXDe;
   VTDWORD   dwYNu;
   VTDWORD   dwYDe;
   } SCCVWIMAGEZOOM;

The image is zoomed in the X (horizontal) direction by a factor of dwXNu/dwXDe. The image is zoomed in the Y (vertical) direction by a factor of dwYNu/dwYDe.

SCCID_BMPZOOMEVENT

This option acts like an event. Normally, its value is SCCVW_ZOOM_NOP.

Data Type

VTDWORD

Data

One of the following values:

SCCID_MAINTAINZOOM

This option tells the Viewer to maintain its zoom and rotation settings when changing sections within a file. As each page of a presentation file is displayed as a new section, this allows a user to zoom to their desired level once, and keep that setting as they page through the presentation, rather than needing to re-zoom on each page.

Data Type

VTBOOL

Default Value

TRUE

SCCID_VECFITMODE

This option sets the way the vector display engine stretches or shrinks an image in relation to the size of the view window.

Data Type

VTDWORD

Data

One of the following values:

SCCID_VECPRINTASPECT

This option indicates how the vector image will be stretched when printed.

Data Type

VTDWORD

Data

One of the following values:

SCCID_VECPRINTBACKGROUND

If TRUE, the background of a vector image will be printed. If it is FALSE the background will not be printed.

Data Type

VTBOOL

SCCID_VECPRINTBORDER

If TRUE, a one-pixel border will be printed around vector images.

Data Type

VTBOOL

SCCID_VECSHOWBACKGROUND

If TRUE, the background of a vector image will be displayed using as defined in the file. If it is FALSE the background will not be displayed.

Data Type

VTBOOL

SCCID_VECSHOWFULLSCREEN

This option acts like an event. Normally its value is FALSE, but when set to TRUE the image will be displayed using the entire screen until the user presses ESC.

The default value of this option has no meaning.

Data Type

VTBOOL

SCCID_VECZOOM

This option indicates the X and Y ratios used to stretch/shrink the original image. For instance, setting the X ratio to 1 and the Y ratio to 2 displays the image pixel for pixel horizontally but 2 display pixels for every one-bitmap pixel in the vertical direction.

Data Type

SCCVWIMAGEZOOM structure

SCCVWIMAGEZOOM Structure

This structure is used in the SCCID_BMPZOOM and SCCID_VECZOOM options.

SCCVWIMAGEZOOM is a C data structure defined in sccvw.h as follows:

typedef struct
   {
   VTDWORD   dwXNu;
   VTDWORD   dwXDe;
   VTDWORD   dwYNu;
   VTDWORD   dwYDe;
   } SCCVWIMAGEZOOM;

The image is zoomed in the X (horizontal) direction by a factor of dwXNu/dwXDe.

The image is zoomed in the Y (vertical) direction by a factor of dwYNu/dwYDe.

SCCID_VECZOOMEVENT

This option acts like an event. Normally, its value is SCCVW_ZOOM_NOP.

Data Type

VTDWORD

Data

One of the following values:

Page Rendering

The following information pertains to page rendering.

SCCID_DEFAULTPRINTMARGINS

This option specifies the top, left, bottom and right margins in twips from the edges of the page. For instance, setting all the values to 1440 creates a 1-inch margin on all sides. Page margins will only be applied when formatting word processing, database and spreadsheet files.

Please note all margins are applied before scaling with the SCCID_SSPRINTFITTOPAGE or SCCID_SSPRINTFITTOPAGE options.

This option is overridden when the SCCID_USEDOCPAGESETTINGS option is set to TRUE and print margins are specified in the input document.

This option does not affect the output of bitmap, presentation, vector or archive files.

Data Type

The SCCVWPRINTMARGINS structure.

SCCVWPRINTMARGINS Structure

This structure is used by the SCCID_DEFAULTPRINTMARGINS option to specify margin settings.

SCCVWPRINTMARGINS is a C data structure defined in sccvw.h as follows:

typedef struct SCCVWPRINTMARGINStag
   {
   VTDWORD  dwTop;
   VTDWORD  dwBottom;
   VTDWORD  dwLeft;
   VTDWORD  dwRight;
} SCCVWPRINTMARGINS,  * PSCCVWPRINTMARGINS;

Parameters

SCCID_PRINTENDPAGE

This option indicates the page that printing should end on. It is only valid if the option SCCID_WHATTOPRINT has the value SCCVW_PRINT_PAGERANGE.

Note: Page range settings are one-based and inclusive. Therefore, specifying a range with SCCID_PRINTENDPAGE equal to 5 and SCCID_PRINTSTARTPAGE equal to 3 would print any of the three pages that follow, if they exist: 3, 4 and 5.

Data Type

VTDWORD

Default

SCCID_PRINTSTARTPAGE

This option indicates the page printing should start on. It is only valid if the option SCCID_WHATTOPRINT has the value SCCVW_PRINT_PAGERANGE.

Note: Page range settings are one-based and inclusive. Therefore, specifying a range with SCCID_PRINTENDPAGE equal to 5 and SCCID_PRINTSTARTPAGE equal to 3 would print any of the three pages that follow, if they exist: 3, 4 and 5.

Data Type

VTDWORD

SCCID_USEDOCPAGESETTINGS

This option is used to select the document’s page layout information when printing.

If TRUE the document’s native (or author selected) page margins, paper size, page scaling and page orientation are used when available from the filter.

The values of the SCCID_DEFAULTPRINTMARGINS, SCCID_SSPRINTGRIDLINES, SCCID_SSPRINTHEADINGS, SCCID_SSPRINTDIRECTION, and SCCID_SSPRINTFITTOPAGE options are overridden if this option is set to TRUE and the properties associated with those options are specified in the input document. Additionally, print area and page breaks in spreadsheet documents are ignored unless this option is set to TRUE.

If FALSE, the printer page margins, paper size, orientation and scaling are set to specific values rather than those in the native document. The page size is forced to 8 1/2” x 11” in portrait orientation, but this may be changed by setting the SCCOPT_GRAPHIC_HEIGHT and/or SCCOPT_GRAPHIC_WIDTH options. The margins are forced 1” all around, but may be changed by setting the SCCID_DEFAULTPRINTMARGINS option. The scaling for the document will be set to 100%, although this may be changed by setting any of the various scaling options.

Data Type

VTBOOL

SCCID_WHATTOPRINT

Note: This option is only valid on the Windows platforms.

This option indicates whether the whole file or a selected range of pages should be printed when the SCCVW_PRINT message is sent.

Data Type

VTDWORD

Data

One of the following values:

Default

SCCVW_PRINT_ALLPAGES

Word Processor File Rendering

The following information pertains to word processor file rendering.

SCCID_WPDISABLEEMAILHEADER

Enables or disables the email view. If disabled, the Normal and Draft viewing modes will not display email headers. If enabled, the email header will be shown for formats identified as email.

Data Type

VTBOOL

Default

0 (email display feature enabled)

SCCID_WPDISPLAYMODE / SCCID_HTMLDISPLAYMODE / SCCID_EMAILDISPLAYMODE

Indicates how the word processor display engine displays documents. Each of these options is applied to different types of Word Processing documents. HTML files are displayed in the mode indicated by SCCID_HTMLDISPLAYMODE, email files are displayed in the mode indicated by SCCID_EMAILDISPLAYMODE, and all other WP files are displayed in the mode specified by SCCID_WPDISPLAYMODE.

Data Type

VTDWORD

Data

One of the following values:

SCCID_WPFITMODE / SCCID_HTMLFITMODE / SCCID_EMAILFITMODE

Controls the size of word processor pages when using preview or weblayout mode.

Data Type

VTDWORD

Data

One of the following values:

SCCID_WPEMAILHEADEROUTPUT

This option controls the rendering of headers for email and associated file types (calender entries, contacts, appointments, etc.). For finer control over these headers, see SCCID_MAILHEADERVISIBLE and SCCID_MAILHEADERHIDDEN. It should be noted that setting this option will reset any fields specified with the SCCID_MAILHEADERVISIBLE or SCCID_MAILHEADERHIDDEN options.

Scope

Global

Data Type

VTDWORD

Data

One of these values:

Default

SCCUT_WP_EMAILHEADERSTANDARD

SCCID_MAILHEADERVISIBLE

Along with SCCID_MAILHEADERHIDDEN, these options exist to allow the developer fine-grained control over what email headers are rendered. These options modify which email headers are displayed, and are based on the most recent setting of SCCID_WPEMAILHEADEROUTPUT. To implement a fully customized set of email headers for display, your code should first set the SCCID_WPEMAILHEADEROUTPUT option to select a baseline set of headers, then use these options to selectively add or remove headers from that set.

Setting a header to be visible means that it will be rendered when that header is found in a document of the appropriate type. Selected headers that are not present in the input file will not have any corresponding output created for them (no ‘empty’ headers will be created). Setting a header to be hidden means that it will not be rendered for the document types specified.

Scope

Global

Data Type

SCCUTEMAILHEADERINFO structure

SCCUTEMAILHEADERINFO structure

This structure is used by the SCCID_WPMAILHEADERVISIBLE/SCCID_WPMAILHEADERHIDDEN options to specify the headers to show or hide.

typedef struct SCCUTEMAILHEADERINFOtag
{
    VTDWORD    dwHeaderID;                         
    VTDWORD    dwSubtypeID;                        
    VTWORD     wsMimeHeaderName[SCCUT_MAIL_NAMELENGTH];
    VTWORD     wsMimeHeaderLabel[SCCUT_MAIL_NAMELENGTH];
} SCCUTEMAILHEADERINFO, *PSCCUTEMAILHEADERINFO;

Parameters:

Note: Support for user-defined MIME headers is intended to allow Outside In to selectively display MIME headers that are not included in the predefined set of email headers known to Outside In. It is likely that most developers using Outside In will not need to specify user-defined MIME headers. Knowledge of the particular MIME headers present in the input email files is necessary in order to take advantage of this capability.

Default

Not used

SCCID_MAILHEADERHIDDEN

Along with SCCID_MAILHEADERVISIBLE, these options exist to allow the developer fine-grained control over what email headers are rendered. These options modify which email headers are displayed, and are based on the most recent setting of SCCID_WPEMAILHEADEROUTPUT. To implement a fully customized set of email headers for display, your code should first set the SCCID_WPEMAILHEADEROUTPUT option to select a baseline set of headers, then use these options to selectively add or remove headers from that set.

Setting a header to be visible means that it will be rendered when that header is found in a document of the appropriate type. Selected headers that are not present in the input file will not have any corresponding output created for them (no ‘empty’ headers will be created). Setting a header to be hidden means that it will not be rendered for the document types specified.

Scope

Global

Data Type

See SCCUTEMAILHEADERINFO structure under SCCID_MAILHEADERVISIBLE

Default

Not used

SCCID_WPWRAPTOWINDOW

Indicates how the word processing display engine wraps text in the window in Normal and Draft modes. Text always wraps to the page size in preview mode. If the option is TRUE (default) the text will wrap to fit in the window. If the option is FALSE, text will not wrap and the horizontal scroll bar will be available for scrolling to the unwrapped text.

Data Type

VTBOOL

Archive Rendering

The following information pertains to archive rendering.

SCCID_ARCOUTPUTPATH

This option string contains the path to save files in.

Data Type

C String

SCCID_ARCRENAME

This option allows prompting the user for input when nodes that are being extracted need to be renamed because the node name already exists, the node name contains illegal characters, or both. The default behavior is for neither of the possible values to be set.

Data Type

VTDWORD

Data

The option can have the following values, OR-ed together if necessary:

SCCID_ARCSAVEEVENT

This option acts like an event.

Data Type

VTDWORD

Data

Normally, the value for this option is SCCVW_ARCHIVE_SAVENOP, but it may be set to either of the following values, as well:

SCCID_ARCSORTORDER

This option sets which attribute to use and the order in which files are displayed in the archive display engine.

Data Type

VTDWORD

Data

One of the following values. Any of these values can be OR-ed with SCCVW_SORT_DESCENDING to force the sorting of the selected attribute to descending order (ascending order is the default when this flag is not set):

SCCID_ARCFULLPATH

In the Viewer and rendering products, this option tells the archive display engine to show the full path to a node in the szNode field in response to a SCCVW_GETTREENODE message. It also causes the name fields in DAGetTreeRecord and DAGetObjectInfo to contain the full path instead of just the archive node name.

Data Type

VTBOOL

**Data **

Default

FALSE

Data Rendering

The following information pertains to data rendering.

SCCID_DAYNAMES

This option sets the full and abbreviated names used to format the days of the week when formatting dates. The default values are retrieved from the localization resource for each platform.

Data Type

SCCVWDAYNAMES structure

SCCVWDAYNAMES Structure

This structure is used by the SCCID_DAYNAMES option to specify the format of day names.

SCCVWDAYNAMES is a C data structure defined in sccvw.h as follows:

typedef struct SCCVWDAYNAMEStag
   {
   VTTCHAR  aFullNames[7][16];
   VTTCHAR  aAbbrevNames[7][16];
   } SCCVWDAYNAMES,  * PSCCVWDAYNAMES;

Parameters

SCCID_IGNORE_PASSWORD

This option can disable the password verification of files where the contents can be processed without validation of the password. If this option is not set, the filter should prompt for a password if it handles password-protected files.

Note: As of Release 8.4.0, only the PST and MDB Filters support this option.

Scope

Global

Data Type

VTBOOL

**Data **

Default

FALSE

SCCID_INTLFLAGS

This option is used to set flags related to international support. The default value is retrieved from the operating system for the Windows platform, and defaults to SCCVW_ENGLISHUNITS OR-ed with SCCVW_12HOURTIME on all other platforms.

Data Type

VTDWORD

Data

One of the following values:

SCCID_MONTHNAMES

This option sets the full and abbreviated names used for formatting dates. The default values are retrieved from the localization resource for each platform.

Data Type

SCCVWMONTHNAMES structure

SCCVWMONTHNAMES Structure

This structure is used to set the SCCID_MONTHNAMES option.

SCCVWMONTHNAMES is a C data structure defined in sccvw.h as follows:

typedef struct
   {
   VTTCHAR   aFullNames[13][16];
   VTTCHAR   aAbbrevNames[13][16];
   } SCCVWMONTHNAMES;

Parameters

SCCID_NUMBERFORMAT

This option is used to control the formatting of numbers. It is useful for setting environment dependent variables related to international support. The default values are retrieved from the operating system for the Windows platform, and are set to logical U.S. defaults on all other platforms.

Data Type

SCCVWNUMBERFORMAT and SCCVWNUMBERFORMAT775 structures

SCCVWNUMBERFORMAT775 and SCCVWNUMBERFORMAT Structures

These structures are used to set the SCCID_NUMBERFORMAT option. The fields of the structures allow the developer to control variables related to international support. Please note that the SCCVWNUMBERFORMAT775 structure always assumes 2-digit year data, whereas the SCCVWNUMBERFORMAT structure allows for both 2- and 4-digital year data.

These are C data structures defined in sccvw.h as follows:

typedef struct SCCVWNUMBERFORMAT775tag
   {
   VTTCHAR   cDecimalSep;
   VTTCHAR   cThousandSep;
   VTTCHAR   cDateSep;
   VTTCHAR   cTimeSep;
   VTTCHAR   szCurrencySymbol[8];
   VTTCHAR   szAM[8];
   VTTCHAR   szPM[8];
   VTDWORD   dwNumBytesAM;
   VTDWORD   dwNumBytesPM;
   VTWORD    wCurrencyPosition;
   VTWORD    wShortDateOrder;
   } SCCVWNUMBERFORMAT775,  * PSCCVWNUMBERFORMAT775;


typedef struct SCCVWNUMBERFORMATtag
   {
   VTTCHAR   cDecimalSep;
   VTTCHAR   cThousandSep;
   VTTCHAR   cDateSep;
   VTTCHAR   cTimeSep;
   VTTCHAR   szCurrencySymbol[8];
   VTTCHAR   szAM[8];
   VTTCHAR   szPM[8];
   VTDWORD    dwNumBytesAM
   VTDWORD   dwNumBytesPM;
   VTWORD    wCurrencyPosition
   VTWORD    wShortDateOrder;
   VTWORD    wShortDateYearDigits;
   VTWORD    wShortDateMonthDigits;
   VTWORD    wShortDateDayDigits;
   VTWORD    wShortDateFlags;
   } SCCVWNUMBERFORMAT,  * PSCCVWNUMBERFORMAT;

Parameters

SCCID_REORDERMETHOD

This option controls how the viewer reorders bidirectional text.

Data Type

VTDWORD

Data

One of the following values:

SCCID_STROKE_TEXT

This option is used to stroke out (display as graphical primitives) text in an AutoCAD file. Setting this option to FALSE would improve performance, but the visual fidelity may be compromised.

Note that when this option is TRUE text is non-searchable, and some special characters appear as asterisks or question marks due to limited support of characters for stroking out text.

Handle Types

VTHDOC, VTHEXPORT

Scope

Local

Data Type

VTBOOL

Default

TRUE

View Window

The following information pertains to the View Window.

SCCID_DEFAULTCLIPBOARDFONT

This option is the font placed on the clipboard (in clipboard formats that support this functionality) when no font is contained within the file being viewed. It is also the font placed on the clipboard for spreadsheets and databases.

Data Type

SCCVWFONTSPEC structure (see the structure documentation in SCCID_DEFAULTPRINTFONT)

SCCID_DEFAULTDISPLAYFONT

This option sets the font used when no font is contained within the file being viewed. It is also the font used in draft mode (when viewing documents) and the font used to display spreadsheets and databases.

Data Type

SCCVWFONTSPEC structure (see the structure documentation in SCCID_DEFAULTPRINTFONT)

SCCID_DIALOGFLAGS

This option controls a number of aspects of the method by which dialogs are displayed and by which dialog choices are added to menus.

Data Type

VTDWORD

Data

One or more of the following values OR-ed together:

SCCID_DISPLAYFONTALIAS

This option sets or gets display font aliases according to the SCCVWFONTALIAS structure.

Data Type

SCCVWFONTALIAS structure

SCCID_FONTSCALINGFACTOR

This option scales fonts in the view of a file by a percentage of the original size. The normal size is 100%. The valid range for this factor is from 40 to 300 with 100 as the default.

Note: For word processor documents, this only affects normal and draft modes. It will not affect paragraph, page or table attributes (for example, margins). For spreadsheet and database documents, the font scaling will affect the row height and column widths. This option will not affect metafile or raster graphics views. For all other document types, only the fonts will be affected

In the context menu, the granularity of an increase/decrease of a font is 20% of the normal size.

Data Type

VTDWORD

SCCID_OLEFLAGS

This option is used to set flags related to OLE features enabled. This flag has meaning only on systems that have OLE 2.0 available. The default value is to have none of the flags set.

Data Type

VTDWORD

Data

SCCID_RESOURCELIBRARYID

Selects the localization string file based on the Resource ID.

Data Type

SCCVWRESOURCEID structure

SCCVWRESOURCEID Structure

This structure is used in the SCCID_RESOURCELIBRARYID option.

SCCVWRESOURCEID is a C data structure defined in sccvw.h as follows:

typedef struct
   {
   VTDWORD   dwSize;
   VTBYTE    szResourceID [SCCVW_RESOURCEIDMAX];
   } SCCVWRESOURCEID;

Parameters

Example

If you use “GR” for a resource file that is localized with German resources the new library must be named as follows:

SCCID_SCROLLFLAGS

This option controls the display of the horizontal and vertical scroll bars. You will need to use both an HSCROLL and a VSCROLL value (from the following list) in the SCCVW_SETOPTION call.

Data Type

VTDWORD

Data

One of the following values:

SCCID_SYSTEMFLAGS

This option controls a number of miscellaneous interactions between the developer and the Viewer Technology.

Note: Every new window automatically has this option reset to 0. If you wish to use any of these flags they must be explicitly set for each view window after it is created.

Data Type

VTDWORD

Data

One of the following values:

SCCID_TOCLIPBOARD

This option controls the clipboard formats that the viewer attempts to place on the clipboard in response to a SCCVW_COPYTOCLIP message.

Data Type

VTDWORD

Data

One or more of the following OR-ed together:

Printing

The following information pertains to printing.

SCCID_DEFAULTPRINTFONT

This option has the same behavior for printing as SCCID_DEFAULTDISPLAYFONT has for display.

SCCVWFONTSPEC Structure

This structure is used by various options to specify a font.

SCCVWFONTSPEC is a C data structure defined in sccvw.h as follows:

typedef struct
   {
   VTTCHAR  szFace[40];
   VTWORD   wHeight;
   VTWORD   wAttr;
   VTWORD   wType;
   } SCCVWFONTSPEC,  * LPSCCVWFONTSPEC;

Parameters

wAttr: The attributes of the font. SCCVW_CHARATTR_NORMAL is the default. Any of the following values can be OR-ed together:

SCCID_PRINTCOLLATE

If TRUE, multiple copies of a printout will be collated. If FALSE, the copies for each page will be printed together.

Data Type

VTBOOL

SCCID_PRINTCOPIES

This option indicates the number of copies of the file, selection or range to print.

Data Type

VTDWORD

SCCID_PRINTFONTALIAS

This option sets or gets printer font aliases according to the SCCVWFONTALIAS structure.

Data Type

The SCCVWFONTALIAS structure.

SCCVWFONTALIAS Structure

This structure is used in the SCCID_PRINTFONTALIAS option.

SCCVWFONTALIAS is a C data structure defined in sccvw.h as follows:

typedef struct SCCVWFONTALIAS
   {
   VTDWORD   dwSize;
   VTDWORD   dwAliasID;
   VTDWORD   dwFlags;
   VTWORD    szwOriginal[SCCVW_FONTNAMEMAX];
   VTWORD    szwAlias[SCCVW_FONTNAMEMAX];
   } SCCVWFONTALIAS;

Parameters

Data

The technology assumes the following default mappings. The first value is the szwOriginal Value, the second is the szwAlias Value.

SCCID_PRINTHEADER

If the value is TRUE, a header containing the page number and the text specified by the SCCID_PRINTJOBNAME option will be printed at the top of each page.

Note: If necessary, the top margin (SCCID_DEFAULTPRINTMARGINS) will be moved down to accommodate the header.

Data Type

VTBOOL

SCCID_PRINTHEADERFONT

This option is the font used when printing the header if SCCID_PRINTHEADER is TRUE.

Data Type

SCCVWFONTSPEC structure

SCCID_PRINTJOBNAME

This option sets the text printed in the header on each page and the job name passed to the OS (if applicable). The characters “%F” appearing in the string will be replaced by the display name of the file being viewed. For instance “My document is [%F]” might result in “My document is [TEST.DOC].”

Data Type

C string of 128 characters (data size is 128 characters, including the terminating zero)

File System

The following information pertains to file systems.

SCCID_IO_BUFFERSIZE

This provides three options that allow the user to adjust buffer sizes to take advantage of faster computers/more memory. This is an advanced option that casual users may ignore. This option allows users to tune memory usage to a particular target machine. The number specified is in kilobytes.

Scope

Global

Data Type

SCCBUFFEROPTIONS Structure

Data

A buffer options structure

SCCBUFFEROPTIONS Structure

typedef struct SCCBUFFEROPTIONStag
{
   VTDWORD dwReadBufferSize;    /* size of the I/O Read buffer 
                                in KB */
   VTDWORD dwMMapBufferSize;    /* maximum size for the I/O   
                                Memory Map buffer in KB */
   VTDWORD dwTempBufferSize;    /* maximum size for the memory-
                                mapped temp files in KB */
   VTDWORD dwFlags;             /* use flags */
} SCCBUFFEROPTIONS, *PSCCBUFFEROPTIONS;

Parameters

Default

The default settings for these options are:

Minimum and maximum sizes for each are:

SCCID_TEMPDIR

From time to time, the technology needs to create one or more temporary files. This option sets the directory to be used for those files.

It is recommended that this option be set as part of a system to clean up temporary files left behind in the event of abnormal program termination. By using this option with code to delete files older than a predefined time limit, the OEM can help to ensure that the number of temporary files does not grow without limit.

Note: This option will be ignored if SCCOPT_REDIRECTTEMPFILE is set.

Scope

Global

Data Type

SCCUTTEMPDIRSPEC structure

SCCUTTEMPDIRSPEC Structure

This structure is used in the SCCID_TEMPDIR option.

SCCUTTEMPDIRSPEC is a C data structure defined in sccvw.h as follows:

typedef struct SCCUTTEMPDIRSPEC
{
   VTDWORD   dwSize;
   VTDWORD   dwSpecType;
   VTBYTE    szTempDirName[SCCUT_FILENAMEMAX];
} SCCUTTEMPDIRSPEC,  * LPSCCUTTEMPDIRSPEC;

There is a limitation in the current release. dwSpecType describes the contents of szTempDirName. Together, dwSpecType and szTempDirName describe the location of the source file. The only dwSpecType values supported at this time are:

Specifically not supported at this time is IOTYPE_REDIRECT.

Parameters

SCCOPT_DOCUMENTMEMORYMODE

This option determines the maximum amount of memory that the chunker may use to store the document’s data, from 4 MB to 1 GB. The more memory the chunker has available to it, the less often it needs to re-read data from the document.

Scope

Global

Data Type

VTDWORD

Parameters

Default

SCCDOCUMENTMEMORYMODE_LARGE (256MB)

SCCOPT_REDIRECTTEMPFILE

This option is set when the developer wants to use redirected IO to completely take over responsibility for the low level IO calls of the temp file.

Scope

Global (not persistent)

Data Type

VTLPVOID: pCallbackFunc

Function pointer of the redirect IO callback.

Redirect call back function:

typedef
{
     VTDWORD (* REDIRECTTEMPFILECALLBACKPROC)
     (HIOFILE *phFile, 
     VTVOID *pSpec, 
     VTDWORD dwFileFlags);

There is another option to handle the temp directory, SCCOPT_TEMPDIR. Only one of these two can be set by the developer. The SCCOPT_TEMPDIR option will be ignored if SCCOPT_REDIRECTTEMPFILE is set. These files may be safely deleted when the Close function is called.