From d96f38ba28a5a23d1e73060ff718bbaf0b287e81 Mon Sep 17 00:00:00 2001
From: Walter Negro <anegro@overnet.com.ar>
Date: Sun, 14 Jul 2002 16:45:48 +0000
Subject: [PATCH]   * doc/en/var.txt     + Add information about HB_ISBYREF().

---
 harbour/doc/en/var.txt | 58 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/harbour/doc/en/var.txt b/harbour/doc/en/var.txt
index 89a8fa0fe3..af8c7ca12d 100644
--- a/harbour/doc/en/var.txt
+++ b/harbour/doc/en/var.txt
@@ -18,6 +18,9 @@
  * Copyright 2001 Chen Kedem <niki@actcom.co.il>
  *    Documentation for: __MVEXIST()
  *
+ * Copyright 2002 Walter Negro <anegro@overnet.com.ar>
+ *    Documentation for: HB_ISBYREF()
+ *
  * See doc/license.txt for licensing terms.
  *
  */
@@ -795,3 +798,58 @@
  *      TYPE()
  *  $END$
  */
+
+/*  $DOC$
+ *  $FUNCNAME$
+ *      HB_ISBYREF()
+ *  $CATEGORY$
+ *      Misc
+ *  $ONELINER$
+ *      Inform if the variable is passed by reference.
+ *  $SYNTAX$
+ *      HB_ISBYREF( @<Var> ) --> <lVarIsByRef>
+ *  $ARGUMENTS$
+ *      @<Var> is the variable to test passed by reference.
+ *  $RETURNS$
+ *      <lVarIsByRef> a logical value indicating if the variable is passed
+ *      by reference to actual function or procedure.
+ *  $DESCRIPTION$
+ *      This function return a logical value indicating if the variable
+ *      is passed by reference to actual function or procedure.
+ *      ATTENTION: The variable to test must be passed by reference.
+ *      If the variable is not passed by reference, the function return NIL.
+ *      This function is based on the form that Harbour manages to the
+ *      variables for reference. When a variable is passed by reference,
+ *      what receives the function or procedure is, a pointer to the
+ *      previous variable, be this the container variable of the data or
+ *      a pointer to another variable. The function observes if the
+ *      variable passed points to a common variable or to a variable
+ *      passed by reference.
+ *  $EXAMPLES$
+ *      See Test
+ *  </fixed>
+ *  $TESTS$
+ *      function Main()
+ *         local cVar := "Test local"
+ *         private nVar := 0
+ *
+ *         Test( @cVar, @nVar, cVar, nVar )
+ *      return nil
+ *
+ *      procedure Test( Arg1, Arg2, Arg3, Arg4 )
+ *         ? hb_isbyref( @Arg1 )        // .T.
+ *         ? hb_isbyref( @Arg2 )        // .T.
+ *         ? hb_isbyref( @Arg3 )        // .F.
+ *         ? hb_isbyref( @Arg4 )        // .F.
+ *      return
+ *  </fixed>
+ *  $STATUS$
+ *      S
+ *  $COMPLIANCE$
+ *      HB_ISBYREF() is an extention of Harbour
+ *  $FILES$
+ *      Library is rtl
+ *  $SEEALSO$
+ *      VALTYPE()
+ *  $END$
+ */