L_VecDlgViewMode

#include "lvdlg.h"

L_LVDLG_API L_INT L_VecDlgViewMode(hWnd, pVector, pnViewMode, dwFlags, pfnCallback, pUserData)

HWND hWnd;

/* window handle */

pVECTORHANDLE pVector;

/* pointer to a vector handle */

L_INT * pnViewMode;

/* view mode */

L_UINT32 dwFlags;

/* user interface flags for dialog */

LVCOMMDLGHELPCB pfnCallback;

/* pointer to a help callback function */

L_VOID * pUserData;

/* pointer to more parameters for the callback */

Brings up the Vector View Mode dialog.

Parameter

Description

hWnd

Handle of the window that owns the dialog.

pVector

Pointer to the vector handle that references the vector image to be affected by the view mode options.

pnViewMode

Pointer to an L_INT variable that contains a view mode value. The value present in the L_INT variable when the function is called is used to initialize the dialog. If this parameter is NULL when the function is called, the value used to initialize the dialog will come from the vector handle. When this function returns, if this parameter is not NULL, the variable pointed to by pnViewMode is updated with the value entered through the dialog. For a list of valid view mode values, refer to L_VecSetViewMode or L_VecGetViewMode.

dwFlags

User interface flags for dialog. Determines the layout and action of the dialog.

 

Value

Meaning

 

VECTOR_DLG_AUTO_PROCESS

[0x80000000] Process the image on OK.

 

VECTOR_DLG_SHOW_PREVIEW

[0x40000000] Show preview of image in dialog.

 

VECTOR_DLG_ENABLE_HELPBUTTON

[0x00000002] Enable Help button.

pfnCallback

Pointer to an optional help callback function.

 

If you do not wish to provide help to this dialog, use NULL as the value of this parameter.

 

To provide help to this dialog, use the function pointer as the value of this parameter.

 

The callback function must adhere to the prototype described in LVCOMMDLGHELPCB.

pUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs.

 

To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure.

 

If the additional parameters are not needed, you can pass NULL in this parameter.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Required DLLs and Libraries

LVDLG

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_VecGetViewMode, L_VecSetViewMode.

Topics:

Vector Common Dialogs

Example

This example will run the common view mode options dialog. 

L_INT VecDlgViewModeExample(
   HWND hWnd,
   pVECTORHANDLE pVector)
{
   L_INT nRet;
   L_INT nViewMode;

   nViewMode = L_VecGetViewMode ( pVector );

   nRet = L_VecDlgViewMode(
      hWnd,
      pVector,
      &nViewMode,
      VECTOR_DLG_AUTO_PROCESS |
      VECTOR_DLG_SHOW_PREVIEW ,
      NULL,
      NULL);

   return nRet;
}