ACTIVESWLib::ISPWeightedFrames Interface Reference
Detailed Description
SignWare Dynamic Development toolkit, container of weighted frames.Interface
ISPWeightedFrames.
Representation of weighted frames in static cleaning. Each frame is described by its coordinates (left, right, top, buttom) and a weight, see sec_Cleaning.
|
Public Member Functions |
| HRESULT | Create ([out, retval] long *result) |
| | Initialize a CSPWeightedFrames instance.
|
| HRESULT | GetBottom ([in] long iIndex,[out] long *piBottom,[out, retval] long *result) |
| | Query the bottom coordinate of a frame entry in this object.
|
| HRESULT | GetEntry ([in] long iIndex,[out] long *piLeft,[out] long *piTop,[out] long *piRight,[out] long *piBottom,[out] double *pdWeight,[out, retval] long *result) |
| | Query a frame entry in this object.
|
| HRESULT | GetLeft ([in] long iIndex,[out] long *piLeft,[out, retval] long *result) |
| | Query the left coordinate of a frame entry in this object.
|
| HRESULT | GetNumberEntries ([out] long *piNumEntries,[out, retval] long *result) |
| | Query the number of frames in this object.
|
| HRESULT | GetRight ([in] long iIndex,[out] long *piRight,[out, retval] long *result) |
| | Query the right coordinate of a frame entry in this object.
|
| HRESULT | GetTop ([in] long iIndex,[out] long *piTop,[out, retval] long *result) |
| | Query the top coordinate of a frame entry in this object.
|
| HRESULT | GetWeight ([in] long iIndex,[out] double *pdWeight,[out, retval] long *result) |
| | Query the weight of a frame entry in this object.
|
Member Function Documentation
| HRESULT ACTIVESWLib::ISPWeightedFrames::Create |
( |
[out, retval] long * |
result |
) |
|
|
|
|
Initialize a CSPWeightedFrames instance.
- Parameters:
-
| result | [o] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetBottom |
( |
[in] long |
iIndex, |
|
|
[out] long * |
piBottom, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the bottom coordinate of a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| piBottom | [o] pointer to an long that will be filled the bottom coordinate of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetEntry |
( |
[in] long |
iIndex, |
|
|
[out] long * |
piLeft, |
|
|
[out] long * |
piTop, |
|
|
[out] long * |
piRight, |
|
|
[out] long * |
piBottom, |
|
|
[out] double * |
pdWeight, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| piLeft | [o] pointer to an long that will be filled the left coordinate of the frame |
| piTop | [o] pointer to an long that will be filled the top coordinate of the frame |
| piRight | [o] pointer to an long that will be filled the right coordinate of the frame |
| piBottom | [o] pointer to an long that will be filled the bottom coordinate of the frame |
| pdWeight | [o] pointer to an long that will be filled the weight of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetLeft |
( |
[in] long |
iIndex, |
|
|
[out] long * |
piLeft, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the left coordinate of a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| piLeft | [o] pointer to an long that will be filled the left coordinate of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetNumberEntries |
( |
[out] long * |
piNumEntries, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the number of frames in this object.
- Parameters:
-
| piNumEntries | [o] pointer to an long that will be filled with number of frames |
| result | [o] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetRight |
( |
[in] long |
iIndex, |
|
|
[out] long * |
piRight, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the right coordinate of a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| piRight | [o] pointer to an long that will be filled the right coordinate of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetTop |
( |
[in] long |
iIndex, |
|
|
[out] long * |
piTop, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the top coordinate of a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| piTop | [o] pointer to an long that will be filled the top coordinate of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
| HRESULT ACTIVESWLib::ISPWeightedFrames::GetWeight |
( |
[in] long |
iIndex, |
|
|
[out] double * |
pdWeight, |
|
|
[out, retval] long * |
result |
|
) |
|
|
|
|
Query the weight of a frame entry in this object.
- Parameters:
-
| iIndex | [i] index of the requested frame |
| pdWeight | [o] pointer to an long that will be filled the weight of the frame |
| result | [i] pointer to an long that will be filled with the SDK result, if the functions returns S_OK
errors:
|
- Returns:
- automation result
|
The documentation for this interface was generated from the following file:
