spdGetUserAbutProc

spdGetUserAbutProc(
?libName t_libName
)
=> r_infoObj / nil

Description

Returns an object containing the registered user abutment options with associated user callbacks and the description that were registered using the spdRegUserAbutProc function.

Arguments

?libName t_libName

Name of the library associated with the user abutment. The default value is nil, which refers to the global abutment callback.

Value Returned

r_infoObj	The object containing options, associated user abutment callbacks and the description for the specified library. This information can be queried using the obj~>? or obj~>?? command. See example below for details of the information returned.
nil	The user abutment callback is not registered.

Example

Register the user abutment and related callbacks.

spdRegUserAbutProc(list("dummyStyle") "MyUserAbutProc" "MyUserAbutCheckProc" "MyUserAbutRestoreProc" ?libName "libA" ?description "user abutment for libA" ?checkOdAbut nil)

=> t

Query the information of current registration.

spdGetUserAbutProc(?libName "libA")~>??

=>

(abutNames 

    ("dummyStyle") abutProc "MyUserAbutProc" checkProc

    "MyUserAbutCheckProc" restoreProc "MyUserAbutRestoreProc" description "user abutment for libA" checkOdAbut nil

Here,

• The user abutment name is "dummyStyle"
• The user callback to perform user abutment in SPD Preview is "MyUserAbutProc"
• The user callback to reject an invalid user abutment in SPD Edit is "MyUserAbutCheckProc"
• The user callback to restore the user abutment during round-trip from layout to SPD Edit is "MyUserAbutRestoreProc"
• The description of the main characteristics for the user callback set is "user abutment for libA"
• The value of checkOdAbut is nil.

Related Topics

spdRegUserAbutProc

User-Defined Abutment Callback Functions

Return to top