Limited time promo

    GetSaveRule2

    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 GetSaveRule2 method returns the save rule for the given index
    HRESULT GetSaveRule2(
    [in ] LONG p_nIndex
    [out ] LONG* p_pnType,
    [out, string ] BSTR* p_pwsName,
    [out, string ] BSTR* p_pwsDescription,
    [out, string ] BSTR* p_pwsText,
    [out, string ] BSTR* p_pwsFormat,
    [out ] BOOL* p_pbEnabled
);

    Parameters:

    p_nIndex
    [in] save rule index

p_pnType
    [out] save rule type (0-remove from start, 1- remove from end, 2 - remove all, 3 - regular expression)

p_pwsName
    [out] rule name

p_pwsDescription
    [out] rule description

p_pwsText
    [out] text to remove or regular expression

p_pwsFormat
    [out] format for regular expression

p_pbEnabled
    [out] flag, tag is enabled

    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_SAVE_RULE - invalid save rule index

    Remarks:

    This method retrieves information about the save rule at given index.