ccpRegMonitor

ccpRegMonitor(
g_copyMonitor
)
=> oldCopyMonitor / nil

Description

Registers the copy monitor that you create. A copy monitor is a program that displays the progress of the copy command while it is being executed.

Arguments

g_copyMonitor

The copy monitor that you want to register, specified as a symbol. Registering a copy monitor removes any copy monitor that was previously registered. If you only want to remove the previous copy monitor but do not want to register a new copy monitor, specify nil for this argument.

Value Returned

oldCopyMonitor	The previously registered copy monitor, if any.
nil	There is no previously registered copy monitor.

Examples

crm_ret = ccpRegMonitor('copyMonitor)

printf("ccpRegMonitor returned \"%L\"\n" crm_ret)

Additional Information

If you want to write a copy monitor function, you must write it in the format described in this section.

The copy monitor function must be fast, otherwise it will affect the performance of the copy command.

The copy monitor must return nil for the copy operation to continue; any non-nil return value cancels the copy operation.

Use the following format for the copy monitor function that you write:

procedure(copyMonitor(myFunction copyPhase fromPath toPath fromSpec toSpec numCount numTotal "ttttggxx")) 
=> nil / non-nil

where

• myFunction is your copy monitor function’s symbol.
• copyPhase is the string "copy".
• fromPath is the path (specified as a string) of the file that is being copied.
  An empty string is also a legal value.
• toPath is the path (specified as a string) to which the file is copied.
  An empty string is also a legal value.
• fromSpec is the gdmSpec object of the file that is being copied.
  nil is also a legal value.
• toSpec is the destination gdmSpec object.
  nil is also a legal value.
• numCount is the count, which is incremented by 1 for each file that is copied.
  The count is terminated at -1: for every copy operation, there is a final call to the copy monitor with numCount = -1.
• numTotal is the total number of files that have to be copied.
  This number may vary during a copy operation, for example, it may increase when the cellview subdirectories are expanded. If this number is negative, it indicates that the copy operation is failing.

The following example creates a copy monitor function that prints some of its arguments.

procedure(copyMonitor(

    copyFn copyPhase fromPath toPath fromSpec toSpec numCount numTotal "ttttggxx")

    if(geqp(numCount 0) then

        if(neq(fromSpec nil) then

            printf("Monitor: %s %L -> %L, %d of %d files.\n" 

                        copyFn 

                        gdmInspectSpec(fromSpec "CDBA")

                        gdmInspectSpec(toSpec "CDBA")

                        numCount numTotal)

            ))

    nil

)

Related Topics

ccpCopyExactDesign

ccpCopyDesign

Return to top