QPR Knowledge Base

GetGraph

Hide Navigation Pane

GetGraph

Previous topic Next topic No expanding text in this topic  

GetGraph

Previous topic Next topic JavaScript is required for expanding text Mail us feedback on this topic!  

Comments (...)

Revision history:

Introduced in QPR 7.3.1

Last changed in QPR 8.1

 

Stores the graphical image of a selected flow chart to the file GraphFileName. GraphFileName i.e. Graphics File Name with the full path is given as a parameter. Additional options can also be defined in the function call.

 

Synopsis:

 

PGModel.GetGraph(ElementId, GraphFileName, Options)

 

Parameters:

 

ElementId: Integer. ID of the desired element. In the case this is 0, the top level flow chart is stored.

GraphFileName: String. Graph file name with a full path included. In the case this parameter is empty, the graph is placed on the clipboard in BMP + metafile format.

Options: String. A ";" separated list of additional parameters. The following options are supported:

TYPE
PNG
BMP (bitmap)
WMF (Windows metafile)
JPG (Jpeg, default)
VIEWSETTINGS
<View Settings ID> Integer. Sets the view setting identified by <View Settings ID> to the graph that is generated. If a view settings ID is not given, an "all visible" view setting is is used.

 

Required Rights:

 

View rights to the process level.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_SUCCESS

RV_APPLICATION_QUIT_CALLED

RV_CANNOT_WRITE_TO_FILE

RV_CANNOT_COPY_TO_CLIPBOARD

RV_ELEMENT_NOT_FOUND

RV_ELEMENT_IS_NOT_SUBPROCESS

RV_INVALID_VIEW_SETTINGS

RV_NO_RIGHTS_TO_MODEL

 

Example Procedure:

 

iResult = PGModel.GetGraph(2345,"C:\temp\flowchart.png", _

              "TYPE=PNG")

 

Comments (...)