• Xbasic COMMENT
• .T.
• .F.
• LET
• DEFINE CLASS ... END CLASS
• DIM ... AS
• DIM...AS...DEFAULT
• Dim ... AS ... New
• Xbasic Arrays
• TYPE ... END TYPE
• CONSTANT, SHARED, GLOBAL
• REDIM
• Namespaces
• Null Table Field Values
• <<%DELIMITER% ... %DELIMITER%
• DELETE
• Operators in Xbasic
• IF ... THEN ... ELSE, ELSEIF
• SELECT ... CASE ... END SELECT
• FOR ... CONTINUE ... NEXT
• FOR ... NEXT, CONTINUE, EXIT FOR
• FOR EACH ... NEXT
• WHILE ... END WHILE, EXIT WHILE
• WITH ... END WITH
• EXIT, EXIT FOR, EXIT FUNCTION, EXIT WHILE
• FUNCTION, EXIT FUNCTION, END FUNCTION
• User-Defined Functions
• END, WEND
• RETURN
• UNDECLARE
• GOTO
• Handling Errors
• ON ERROR GOTO, RESUME NEXT
• RESUME, RESUME NEXT
• STOP
• MODE
• OPTION
• PARENT
• PARENTFORM
• TOPPARENT
• THIS
• YIELD CONTROL
• <%A5 ? ... %>
• A5WINCLUDE
• IMPORT PACKAGE
• Argument_List Data Structure
• Automating Your Alpha Anywhere Applications
• Class Attribute Keywords
• Class Scope Keywords
• Classes
• Code Indirection
• Collections
• Command Statements
• Compiling the Script
• Defining a Function with Optional Pointer Variables
• Expression Components
• Getting the Name of the Currently Running Script or Function
• Modifying Object Event Code on the Fly
• Quoted Xbasic Statement
• Reserved Words
• Variable Data Types
• Xbasic Reference
• MACRO
• DECLARE
• DECLARESTRUCT

Defining a Function with Optional Pointer Variables

Description

To define a function with an optional pointer variable, you must follow the function declaration syntax illustrated below. The parameter = value portion of the declaration is how a default value is defined. NULL_VALUE() is used to assign a NULL value to a pointer.

Examples

The following function examines the parameters sent to it and responds with a message box that says what it received.

function fooFunc as P (param = NULL_VALUE())
'shows how a function can have either no argument or an optional pointer argument
    if typeof(param) = "P" then
        ui_msg_box("Properties of input parameter", properties_enum(param))
    else if typeof(param) = "Z"
        ui_msg_box("","User did not pass in any parameters to the function")
        'note: typeof(param) will return "Z"
    else
        ui_msg_box("","This function expects either a Pointer argument, or no argument at all. You have specified a " + typeof(param) + " argument")
end if

The following code in the Interactive window shows the function in action.

p.name = "selwyn"
p.city = "boston"
fooFunc(p)
fooFunc()
fooFunc(23)

See Also

• Dot Variables