PollEx PCB API Function Reference
Table of Contents
1. PPCB_Launch
2. PPCB_Exit
3. PPCB_SetWindowPosition
4. Zoom Control
4.1 PPCB_ZoomIn
4.2 PPCB_ZoomOut
4.3 PPCB_ZoomFitSize
4.4. PPCB_ZoomArea
5. PPCB_ViewMirror
6. PPCB_RotateBoard
7. PPCB_Component_OnOff
8. PPCB_Route_OnOff
9. Layer Control
9.1 PPCB_ViewLayer_Top
9.2 PPCB_ViewLayer_Btm
9.3 PPCB_ViewLayer_All
9.4 PPCB_Visible_Layers_Only
9.5 PPCB_Visible_Layers
9.6 PPCB_Visible_ECAD_Layers_Only
9.7 PPCB_Visible_ECAD_Layers
10. Highlight Control
10.1 PPCB_Highlight_Clear
10.2 PPCB_Highlight_SetCurrentColor
10.2.1 PPCB_Highlight
10.3 PPCB_Highlight_DependentColor
10.4 PPCB_Highlight_RefPin
11. Get Information Control
11.1 PPCB_GetReferencePlaceStatus
11.2 PPCB_GetReferenceCountForPlace
11.3 PPCB_GetReferenceCountForPlaceOfPart
11.4 PPCB_GetPinPitch
11.5 PPCB_GetPinPitchFrom2PinComponent
11.6 PPCB_GetPinCountFromPart
11.7 PPCB_GetPinCountFromReference
12. Tool_Control
12. 1 PPCB_PickingTool_OnOff
13. Auto Zoom-in & Highlight
13.1 PPCB_GetPinListInfoOfNet_RefPin
13.2 PPCB_ZoomHighlightForSection_NetRefPin
14. Red-mark Related Functionalities
14.1 PPCB_RedMark_OnOff
14.2 PPCB_RedMarkLoad
14.3 PPCB_RedMarkSave
14.4 PPCB_CallSelectedItemFromRedMark
14.5 PPCB_SetStatusForCallingRedMark
14.6 PPCB_ExportBitmap_CurrentImage
15. PPCB_MiniMap_OnOff
Parameter attributes
[in] : Input parameter
[out] : Output parameter
1. PPCB_Launch
- Launch PollEx PCB
Function PPCB_Launch(
sPdbbFilePath As String ‘// [in] Path and name of a pdbb file.
) As Long
- Parameters
n sPdbbFilePath
u Path and name of a pdbb file to open on PollEx PCB.
- Return Values
n If the function succeeds, the return value is a process ID of PollEx PCB running. The process ID will be used for the first argument of other functions.
n If the function fails, the return values are as follows.
|
Define Name |
Define Value |
Description |
|
PPCBR_CANNOT_FIND_PDBB_FILE |
-200 |
Cannot find pdbb file. |
|
PPCBR_CANNOT_FIND_POLLEX_PCB_EXE |
-201 |
Cannot find PollEx PCB executable. |
|
PPCBR_CANNOT_CREATE_POLLEX_PCB_PROCESS |
-202 |
Cannot create PollEx PCB process. |
2. PPCB_Exit
- Exit PollEx PCB
Function PPCB_Exit(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function).
bWait As Boolean ‘// [in] True or false of return value when exit PollEx PCB.
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n bWait
u True or false of return value. In case of False, Return value is PPCBR_NO_WAIT.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_NO_WAIT |
-2 |
Do not ensure exit status. Only if bWait == FALSE |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find PollEx-PCB executable. |
3. PPCB_SetWindowPosition
- Set the window of PollEx PCB
Function PPCB_SetWindowPosition(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
nLeftTopX As Long, ‘// [in] Value of left side
nLeftTopY As Long, ‘// [in] Value of left upper
nWidth As Long, ‘// [in] Value of width
nHeight As Long ‘// [in] Value of Height
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n nLeftTopX
u Value of left side
n nLeftTopY
u Value of left upper
n nWidth
u Value of width (Window of PollEx PCB)
n nHeight
u Value of height (Window of PollEx PCB)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
4. Zoom Control
4.1 PPCB_ZoomIn
- Zoom In
Function PPCB_ZoomIn(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
4.2 PPCB_ZoomOut
- Zoom Out
Function PPCB_ZoomOut(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
4.3 PPCB_ZoomFitSize
- Zoom Fit
Function PPCB_ZoomFitSize(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
4.4 PPCB_ZoomArea
- Zoom of PCB Board
Function PPCB_ZoomArea(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
dZoomCenterX As Double, ‘// [in] Center Location(X) of Zooming area
dZoomCenterY As Double, ‘// [in] Center Location(Y) of Zooming area
dZoomAreaWidth As Double, ‘// [in] Width of zooming area
dZoomAreaHeight As Double ‘// [in] Height of zooming area
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n dZoomCenterX
u Center Location(X) of Zooming area
n dZoomCenterY
u Center Location(Y) of Zooming area
n dZoomAreaWidth
u Width of zooming area
n dZoomAreaHeight
u Height of zooming area
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
5. PPCB_ViewMirror
- Mirror of PCB Board
Function PPCB_ViewMirror(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
bOn As Boolean ‘// [in] Mirror value (True or False)) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n bOn
u Mirror value(True : Mirror On, False : Mirror Off)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
6. PPCB_RotateBoard
- Rotate PCB Board
Function PPCB_RotateBoard(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
dAngle As Double ‘// [in] Rotation Angle
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n dAngle
u Rotation Angle
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
7. PPCB_Component_OnOff
- Display mode (Component On/Off)
Function PPCB_Component_OnOff(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
bOn As Boolean ‘// [in] Display component or not (True or False)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n bOn
u Display option
8. PPCB_Route_OnOff
- Display mode (Patten On/Off)
Function PPCB_Route_OnOff(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
bOn As Boolean ‘// [in] Display pattern or not (True or False)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n bOn
u Display option
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9. Layer Control
9.1 PPCB_ViewLayer_Top
- Layer control as Top
Function PPCB_ViewLayer_Top(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.2 PPCB_ViewLayer_Btm
- Layer control as Bottom
Function PPCB_ViewLayer_Btm(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.3 PPCB_ViewLayer_All
- Layer control as All
Function PPCB_ViewLayer_All(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.4 PPCB_Visible_Layers_Only
- Display Layer
Function PPCB_Visible_Layers_Only(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sLayerNames As String ‘// [in] PollEx PCB Layer Name
sDelimiter As String ‘// [in] Delimiter for multi layer names
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u PollEx PCB Layer Name
n sDelimiter
u Delimiter for multi layer names
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.5 PPCB_Visible_Layers
- Turn on or turn off the Layer.
Function PPCB_Visible_Layers(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sLayerNames As String ‘// [in] PollEx PCB Layer Name
sDelimiter As String ‘// [in] Delimiter for multi layer names
bOn As Boolean ‘// [in] Visible Layer (True or False)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u PollEx PCB Layer Name
n sDelimiter
u Delimiter for multi layer names
n bOn
u On/Off Visible status for layer
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.4 PPCB_Visible_ECAD_Layers_Only
- Turn on the layer using ECAD Layer name.
Function PPCB_Visible_ECAD_Layers_Only(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sLayerNames As String ‘// [in] Name of ECAD Layer
sDelimiter As String ‘// [in] Delimiter for multi layer names
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Name of ECAD Layer
n sDelimiter
u Delimiter for multi layer names
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
9.5 PPCB_Visible_ECAD_Layers
- Turn on or turn off the layer using ECAD Layer name.
Function PPCB_Visible_ECAD_Layers(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sLayerNames As String ‘// [in] Name of ECAD Layer
sDelimiter As String ‘// [in] Delimiter for multi layer names
bOn As Boolean ‘// [in] Visible Layer (True or False)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Name of ECAD Layer
n sDelimiter
u Delimiter for multi layer names
n bOn
u On/Off Visible status for layer
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
10. Highlight Control
10.1 PPCB_Highlight_Clear
- Clear highlight mode
Function PPCB_Highlight_Clear(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
10.2 PPCB_Highlight_SetCurrentColor
- If use this command for highlighting, current highlight color will be changed for selected objects.
Function PPCB_Highlight_SetCurrentColor(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
nRedValue As Long, ‘// [in] Red color value ( 0 ~ 255 )
nGreenValue As Long, ‘// [in] Green color value ( 0 ~ 255 )
nBlueValue As Long, ‘// [in] Blue color value ( 0 ~ 255 )
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n nRedValue/ nGreenValue/ nBlueValue
u Color value
l Ex) ( Red, Green, Blue)
n ( 0, 0, 0 ) : Black
n ( 255, 255, 255 ) : White
n ( 255, 0, 0 ) : Red
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
- Highlight the selected object ( Reference/ Part / Net )
Function PPCB_Highlight(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
nHighlightObjType As Long, ‘// [in] Type of object
sObjectNameLists As String, ‘// [in] Name of selected object
sDelimiter As String ‘// [in] Delimiter for multi objects
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n nHighlightObjType
u Type of object
|
Define Name |
Define Value |
Description |
|
HOT_PART |
0 |
Part |
|
HOT_REF |
1 |
Reference |
|
HOT_NET |
2 |
Net |
n sObjectNameLists
u Input the name of object. In case of multi objects, use delimiter.
l Ex)
n Single : ‘U1’
n Multi : ‘U1, U2, R1, R2’
u Delimiter : ‘, ‘
n sDelimiter
u Delimiter value
l Ex)
n sObjectNameLists : ‘U1, U2, R1, R2’ sDelimiter : ‘, ‘
n sObjectNameLists : ‘U1:U2:R1:R2’ sDelimiter : ‘:
- Remarks
n When defined objected will be highlight, color will be changed by function of PPCB_Highlight_SetCurrentColor.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
10.3 PPCB_Highlight_DependentColor
- Highlight the selected object ( Reference/ Part / Net )
Function PPCB_Highlight_DependentColor(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
nHighlightObjType As Long, ‘// [in] Type of object
sObjectNameLists As String, ‘// [in] Name of selected object
sDelimiter As String ‘// [in] Delimiter for multi objects
nRedValue As Long, ‘// [in] Red color value ( 0 ~ 255 )
nGreenValue As Long, ‘// [in] Green color value ( 0 ~ 255 )
nBlueValue As Long, ‘// [in] Blue color value ( 0 ~ 255 )
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n nHighlightObjType
u Type of object
|
Define Name |
Define Value |
Description |
|
HOT_PART |
0 |
Part |
|
HOT_REF |
1 |
Reference |
|
HOT_NET |
2 |
Net |
n sObjectNameLists
u Input the name of object. In case of multi objects, use delimiter.
l Ex)
n Single : ‘U1’
n Multi : ‘U1, U2, R1, R2’
u Delimiter : ‘, ‘
n sDelimiter
u Delimiter value
l Ex)
n sObjectNameLists : ‘U1, U2, R1, R2’ sDelimiter : ‘, ‘
n sObjectNameLists : ‘U1:U2:R1:R2’ sDelimiter : ‘:
n nRedValue/ nGreenValue/ nBlueValue
u Color value
l Ex) ( Red, Green, Blue)
n ( 0, 0, 0 ) : Black
n ( 255, 255, 255 ) : White
n ( 255, 0, 0 ) : Red
- Remarks
n Defined color of highlight by using this function, previous highlighted objects are not changed as same color.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
10.4 PPCB_Highlight_RefPin
- Highlighting and Zooming in Pin(s) of Reference. (Last updated on 9 Feb. 2010)
Function PPCB_Highlight_RefPin(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sRefName As String, ‘// [in] Ref Name of selected (One Reference)
sPinNameLists As String, ‘// [in] Pin Name of selected
sDelimiter As String ‘// [in] Delimiter for multi objects
nRedValue As Long, ‘// [in] Red color value ( 0 ~ 255 )
nGreenValue As Long, ‘// [in] Green color value ( 0 ~ 255 )
nBlueValue As Long, ‘// [in] Blue color value ( 0 ~ 255 )
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n nHighlightObjType
u Type of object
|
Define Name |
Define Value |
Description |
|
HOT_PART |
0 |
Part |
|
HOT_REF |
1 |
Reference |
|
HOT_NET |
2 |
Net |
n sRefName
u Input the name of Reference (One Reference)
l Ex)
u Single : ‘U1’
n sPinNameLists
u Input the name of Pin. In case of multi objects, use delimiter.
l Ex)
n Single : ‘1’
n Multi : ‘1, 2, 3, 4’
u Delimiter : ‘, ‘
n sDelimiter
u Delimiter value
l Ex)
n sObjectNameLists : ‘1, 2, 3, 4’ sDelimiter : ‘, ‘
n sObjectNameLists : ‘
n nRedValue/ nGreenValue/ nBlueValue
u Color value
l Ex) ( Red, Green, Blue)
n ( 0, 0, 0 ) : Black
n ( 255, 255, 255 ) : White
n ( 255, 0, 0 ) : Red
- Remarks
n Defined color of highlight by using this function, previous highlighted objects are not changed as same color.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11. Get Information Control
11.1 PPCB_GetReferencePlaceStatus
- Get Component count for place status
Function PPCB_GetReferencePlaceStatus(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sReferenceName, ‘// [in] Reference name (One Reference)
nStatusOfPlace As Long ‘// [out] Status of placement, (0:Top, 1:Bottom, -1:Nothing)
bHighlight As Boolean ‘// [in] Highlight reference for top/bottom reference
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Reference name
n nStatusOfPlace
u Status of placement, (0:Top, 1:Bottom, -1:Nothing)
n bHighlight
u Highlight reference for top/bottom reference
- Remarks
n When defined objected will be highlight, color will be changed by function of PPCB_Highlight_SetCurrentColor.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.2 PPCB_GetReferenceCountForPlace
- Get Component count for place status
Function PPCB_GetReferencePlaceStatus(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sReferenceNameLists As String ‘// [in] Reference name list
sDelimiter As String ‘// [in] Delimiter for multi reference name
nTopCount As Long, ‘// [out] Top layer place count
nBottomCount As Long, ‘// [out] Bottom layer place count
nElseCount As Long, ‘// [out] None placed reference count
bHighlight As Boolean ‘// [in] Highlight reference for top/bottom reference
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceNameLists
u Reference name list
n sDelimiter
u Delimiter for multi reference name
n nTopCount
u Top layer place count
n nButtomCount
u Bottom layer place count
n nElseCount
u None placed reference count
n bHighlight
u Highlight reference for top/bottom reference
- Remarks
n When defined objected will be highlight, color will be changed by function of PPCB_Highlight_SetCurrentColor.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.3 PPCB_GetReferenceCountForPlaceOfPart
- Get Component count for place status
Function PPCB_GetReferencePlaceStatus(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sPartNameLists As String, ‘// [in] Part name list
sDelimiter As String ‘// [in] Delimiter for multi reference name
nTopCount As Long, ‘// [out] Top layer place count
nBottomCount As Long, ‘// [out] Bottom layer place count
nElseCount As Long, ‘// [out] None placed reference count
bHighlight As Boolean ‘// [in] Highlight reference for top/bottom reference
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sPartNameLists
u Part name list
n sDelimiter
u Delimiter for multi reference name
n nTopCount
u Top layer place count
n nButtomCount
u Bottom layer place count
n nElseCount
u None placed reference count
n bHighlight
u Highlight reference for top/bottom reference
- Remarks
n When defined objected will be highlight, color will be changed by function of PPCB_Highlight_SetCurrentColor.
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.4 PPCB_GetPinPitch
- Get component pin pitch
Function PPCB_GetPinPitch(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sReferenceName As String ‘// [in] Name of reference
nUnit As Long ‘// [in] Unit
nPinPitch As Double, ‘// [out] Component pin pitch
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Name of reference
n nUnit
u Unit
n nPinPitch
u Component pin pitch
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.5 PPCB_GetPinPitchFrom2PinComponent
- Get Pin pitch for only 2 Pin component
Function PPCB_GetPinPitchFrom2PinComponent(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sReferenceName As String ‘// [in] Name of reference
nUnit As Long ‘// [in] Unit
nPinPitch As Double, ‘// [out] Component pin pitch
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Name of reference
n nUnit
u Unit
n nPinPitch
u Component pin pitch
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.6 PPCB_GetPinCountFromPart
- Get number of Pin using Part Name.
Function PPCB_GetPinCountFromPart(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sPartName As String ‘// [in] Name of part
nPinCount As Long, ‘// [out] Component pin count
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sPartName
u Name of part
n nPinCount
u Component pin count
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
11.7 PPCB_GetPinCountFromReference
- Get number of Pin using Reference Name.
Function PPCB_GetPinCountFromReference(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
sReferenceName As String ‘// [in] Name of reference
nPinCount As Long, ‘// [out] Reference pin count
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n sReferenceName
u Name of Reference
n nPinCount
u Reference pin count
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
12. Tool_Control
12. 1 PPCB_PickingTool_OnOff
- Turn on or turn off the Picking Tool.
Function PPCB_PickingTool_OnOff
nPollExPCB_ID As Long, ‘//[in] Process ID of PollEx PCB (Return value of the PPCB_Launch function)
bOn As Boolean ‘//[in] Picking Tool On/Off
) As Long
- Parameters
n nPollExPCB_ID
u ProcessID of PollEx PCB(Return value of PPCB_Launch function)
n bOn
u Tool On/Off option
- Return Values
n Return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB |
13. Auto Zoom-in & Highlight
13.1 PPCB_GetPinListInfoOfNet_RefPin
Function PPCB_GetPinListInfoOfNet_RefPin(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sRefName As String ‘// [in] Name of a reference.
sPinName As String ‘// [in] Name of a pin.
sNetName As String ‘// [out] Net name which is associated with the reference name and pin name input.
sPinList As String ‘// [out] Pin list which is associated with the reference name and pin name input.
sPinListDelimiter As String ‘// [in] Delimiter which is used to divide the pin list output into pins with their reference name.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Retrieves a pin list which is associated with a reference name and pin name input as arguments.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sRefName
u Name of a reference.
n sPinName
u Name of a pin.
n sNetName
u Net name which is associated with the reference name and pin name input.
n sPinList
u Pin list which is associated with the reference name and pin name input.
n sPinListDelimiter
u Delimiter which is used to divide the pin list output into pins with their reference name.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
|
PPCBR_COM_RETURN_VAL_RECEIVE_FAIL |
-7 |
Failed to receive a return value. |
|
PPCBR_CANNOT_FIND_REFPIN_NAME |
-200 |
Cannot find the combination of the reference and pin name. |
13.2 PPCB_ZoomHighlightForSection_NetRefPin
Function PPCB_ZoomHighlightForSection_NetRefPin(
nPollExPCB_ID As Long ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sNetName As String, ‘// [in] Name of a net which is to be a target for zooming in and highlighting it.
sRef1Name As String ‘// [in] Name of a reference which is to be a start point for a section zoomed in and highlighted. It must be paired with a right related pin name of the next argument.
sPin1Name As String ‘// [in] Name of a pin which is to be a start point for a section zoomed in and highlighted.
sRef2Name As String ‘// [in] Name of a reference which is to be an end point for a section zoomed in and highlighted. It must be paired with a right related pin name of the next argument.
sPin2Name As String ‘// [in] Name of a pin which is to be an end point for a section zoomed in and highlighted.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Zooms in and highlights a section within a net which you specify.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sNetName
u Name of a net which is to be a target for zooming in and highlighting it.
n sRef1Name
u Name of a reference which is to be a start point for a section zoomed in and highlighted. It must be paired with a right related pin name of the next argument.
n sPin1Name
u Name of a pin which is to be a start point for a section zoomed in and highlighted.
n sRef2Name
u Name of a reference which is to be an end point for a section zoomed in and highlighted. It must be paired with a right related pin name of the next argument.
n sPin2Name
u Name of a pin which is to be an end point for a section zoomed in and highlighted.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
|
PPCBR_COM_RETURN_VAL_RECEIVE_FAIL |
-7 |
Failed to receive a return value. |
|
PPCBR_CANNOT_FIND_REFPIN_NAME |
-200 |
Cannot find the combination of the reference and pin name. |
|
PPCBR_CANNOT_FIND_NET_NAME |
-201 |
Cannot find the net name. |
14. Red-mark Related Functionalities
14.1 PPCB_RedMark_OnOff
Function PPCB_RedMark_OnOff(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
bOn As Boolean ‘// [in] Specifies whether to show or hide the red-mark pane.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Toggles the red-mark pane on and off.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n bOn
u Specifies whether to show or hide the red-mark pane. If the argument is True, the pane is showed up, and vice versa.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
14.2 PPCB_RedMarkLoad
Function PPCB_RedMarkLoad(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sRedMarkFilePath As String ‘// [in] Path and file name to load red-mark records from.
sTitleNames As String ‘// [out] Title names which represent each of red-mark records.
sTitleNameDelimiter As String ‘// [out] Delimiter which is used to divide up output sTitleNames string into title names.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Retrieves title names of red-mark records from a red-mark file.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sRedMarkFilePath
u Path and file name of a red-mark to load from.
n sTitleNames
u Title names which represent each of red-mark records.
n sTitleNameDelimiter
u Delimiter which is used to divide up output sTitleNames string into title names.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
|
PPCBR_COM_RETURN_VAL_RECEIVE_FAIL |
-7 |
Failed to receive a return value. |
|
PPCBR_CANNOT_FIND_REDMARK_FILE |
-200 |
Cannot find the red-mark file to read. |
14.3 PPCB_RedMarkSave
Function PPCB_RedMarkSave(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sRedMarkFilePath As String ‘// [in] Path and file name to save red-mark records into.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Saves red-mark records into a red-mark file.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sRedMarkFilePath
u Path and file name to save red-mark records into.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
14.4 PPCB_CallSelectedItemFromRedMark
Function PPCB_CallSelectedItemFromRedMark(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sTitleName As String ‘// [in] Title name which specifies a red-mark record.
sContents As String ‘// [out] Contents of a red-mark record specified by the tile name, sTitleName input.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Shows up the red-mark information determined by the title name input and retrieves the contents which is subordinate to the title name.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sTitleName
u Title name which specifies a red-mark record.
n sContents
u Contents of a red-mark record specified by the tile name, sTitleName input.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
|
PPCBR_COM_RETURN_VAL_RECEIVE_FAIL |
-7 |
Failed to receive a return value. |
|
PPCBR_CANNOT_FIND_REDMARK_TITLE |
-200 |
Cannot find the red-mark title. |
|
PPCBR_DUPLICATE_REDMARK_TITLE |
-201 |
The red-mark title name to be added already exists. |
14.5 PPCB_SetStatusForCallingRedMark
Function PPCB_SetStatusForCallingRedMark(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
nCall_Status As Long ‘// [in] Determines what clicking the left mouse button does while the red-mark pane is on.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Makes the red-mark pane on and sets the marking mode.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n nCall_Status
u Determines what clicking the left mouse button does while the red-mark pane is on.
0 : Makes the red-mark pane on. If the marking mode is on, it gets off.
1 : Makes both the red-mark pane and the marking mode on. When the marking mode is on and the left mouse button is clicked on a view, an X-shaped mark is drawn in the center of the nearest segment on a net highlighted.
-1 : Makes the marking mode off regardless whether it is on or not.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
14.6 PPCB_ExportBitmap_CurrentImage
Function PPCB_ExportBitmap_CurrentImage(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
sSaveFilePath As String ‘// [in] Path and file name to save a snapshot of the current view into.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Saves a snapshot of the current view into a BMP file.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n sSaveFilePath
u Path and file name to save a snapshot of the current view into.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |
15. PPCB_MiniMap_OnOff
Function PPCB_MiniMap_OnOff(
nPollExPCB_ID As Long, ‘// [in] Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
bOn As Boolean ‘// [in] Specifies whether to show or hide the Board Mini Map window.
) As Long
- Member of POLLEXPCB_COMDLLLib.PollExPCB
- Toggles the Board Mini Map window on and off.
- Parameters
n nPollExPCB_ID
u Process ID of PollEx PCB. This must be a return value of the PPCB_Launch function.
n bOn
u Specifies whether to show or hide the Board Mini Map window. If the argument is True, the pane is showed up, and vice versa.
- Return Values
n The following is the return values of the function.
|
Define Name |
Define Value |
Description |
|
PPCBR_SUCCESS |
0 |
Success. |
|
PPCBR_CANNOT_FIND_TARGET_POLLEX_PCB |
-4 |
Cannot find target PollEx PCB. |
|
PPCBR_COM_INIT_ERROR |
-5 |
Communication initialization error. |

Technical Notes