cwbOBJ_IsViewerAvailable

Purpose

Checks if the spooled file viewer is available.

Syntax

 
unsigned int CWB_ENTRY  cwbOBJ_IsViewerAvailable(
                               cwbSV_ErrHandle   errorHandle);

Parameters

cwbSV_ErrHandle errorHandle - output

Optional, may be 0. Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle() API. The messages may be retrieved through the cwbSV_GetErrText() API. If the parameter is set to zero, no messages will be retrievable.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion (viewer is installed).

CWB_NO_VIEWER

Viewer not installed.

Usage

Use this function to test for the presence of the viewer on the workstation. If the viewer is installed this function will return CWB_OK. If the viewer is not available, the function will return CWB_NO_VIEWER and the errorHandle parameter (if provided) will contain an appropriate error message. Using this function, applications can check for viewer support without calling the cwbOBJ_DisplaySplF() API.