L_VecDlgEditGroup

#include "lvdlg.h"

L_LVDLG_API L_INT L_VecDlgEditGroup(hWnd, pVector, pGroup, pGroupDesc, dwFlags, pfnCallback, pUserData)

HWND hWnd;

/* window handle */

pVECTORHANDLE pVector;

/* pointer to a vector handle */

pVECTORGROUP pGroup;

/* pointer to a vector group */

pVECTORGROUPDESC pGroupDesc;

/* pointer to a structure */

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 Edit Group dialog. This function is available in the LEADTOOLS Vector Imaging Pro Toolkit.

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 edit group dialog.

pGroup

Pointer to a VECTORGROUP structure that references the group to be edited.

pGroupDesc

Pointer to a VECTORGROUPDESC structure that contains group parameters. The values present in the structure when the function is called are used to initialize the dialog. If this parameter is NULL when the function is called, values obtained from the pGroup parameter will be used to initialize the dialog. When this function returns, if this parameter is not NULL, the structure will be updated with the values entered through the dialog.

dwFlags

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

 

Value

Meaning

 

VECTOR_DLG_AUTO_PROCESS

[0x80000000] Process the vector on OK.

 

VECTOR_DLG_NO_RETURN_DUPLICATE

[0x00000001] Do not return duplicate group names.

 

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.

Comments

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_VecDlgEditAllGroups, L_VecDlgNewGroup

Topics:

Vector Common Dialogs

Example

This example will edit the given group. 

L_INT VecDlgEditGroupExample(
   HWND hWnd,
   pVECTORHANDLE pVector,
   const L_TCHAR* pszGroupName)
{
   L_INT nRet;
   VECTORGROUP Group;

   nRet = L_VecGetGroupByName ( pVector, pszGroupName, &Group);
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_VecDlgEditGroup(
      hWnd,
      pVector,
      &Group,
      NULL,
      VECTOR_DLG_AUTO_PROCESS,
      NULL,
      NULL);

   return nRet;
}