Limited time promo

    GetOverlayOptionLong

    English

    This help topic applies only to novaPDF. If you don't have it yet, you must download it first.

    Download now Buy licenses
    Apr 14, 2022
    novaPDF 11.x
    We strive to keep our help as accurate as possible. If you notice any inconsistencies or outdated info please let us know.
    The GetOverlayOptionLong method retrieves an overlay option of boolean type
    HRESULT GetOverlayOptionLong(
    [in, string] LPCWSTR p_wsOverlayId,
    [in] LONG p_nOption,
    [out] LONG* p_plValue
);

    Parameters:

    p_wsOverlayId
    [in] overlay id (obtained with [AddOverlay](addoverlay-help.html) )

p_nOption
    [in] option constant

p_plValue
    [out] pointer to a long that will contain the value of the retrieved option

    Return values:

    S_OK on success or COM error code
    NV_NOT_INITIALIZED - Initialize was not called
    NV_UNKNOWN_PROFILE - no profile loaded
    NV_INVALID_OVERLAY - wrong overlay id
    NV_INVALID_OPTION - wrong option constant
    NV_PROFILE_ERROR - cannot find option in profile
    NV_WRONG_OPTION_TYPE - option is not of type long

    Remarks:

    You can find the complete list of option names in the Profile option strings chapter. In the Include folder of novaPDF SDK installation folder you can find the definitions for all options in the next files: novaOptions.h, novaOptions.pas, Globals.bas.