ImageGear Professional DLL v17.1 for Windows Accusoft
IG_REC_converter_pagemargins_get
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Converter Settings Functions > IG_REC_converter_pagemargins_get

Glossary Item Box

Returns left, top, right, and bottom margins of the output page, in TWIPS (1/1400 inch).

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_REC_converter_pagemargins_get(
   LPCSTR lpszFormatName,
   LPAT_INT lpLeft,
   LPAT_INT lpTop,
   LPAT_INT lpRight,
   LPAT_INT lpBottom
);

Arguments:

lpszFormatName Symbolic name of the output format like Converters.Text.Cvs.
lpLeft Buffer to retrieve the left margin value.
lpTop Buffer to retrieve the top margin value.
lpRight Buffer to retrieve the right margin value.
lpBottom Buffer to retrieve the bottom margin value.

Return Value:

The number of ImageGear errors that occurred during the function call.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

See IG_REC_converter_pagemargins_usage_set for formats that support this setting. Use IG_REC_converter_pagemargins_is_applicable to know whether the specified format supports margins.

Margins can't be retrieved if the corresponding output format has not been selected with IG_REC_output_format_set at least once. In this case the function returns a non-zero value and appends IGE_REC_CONVERTER_NOT_INITIALIZED error code to the error stack.

Example:

  Copy Code
AT_ERRCOUNT ErrCount = 0;
AT_BOOL bCPMIsApplicable = FALSE;
LPCSTR lpszFormatName = "Converters.Text.Csv";
AT_INT iMLeft = 0;
AT_INT iMTop = 0;
AT_INT iMRight = 0;
AT_INT iMBottom = 0;

ErrCount += IG_REC_output_format_set(lpszFormatName);
ErrCount += IG_REC_converter_pagemargins_is_applicable(lpszFormatName,
     &bCPMIsApplicable);
if(bCPMIsApplicable)
    ErrCount += IG_REC_converter_pagemargins_get(lpszFormatName,
        &iMLeft, &iMTop, &iMRight, &iMBottom);

©2012. Accusoft Corporation. All Rights Reserved.