ccpSetAutoRename

ccpSetAutoRename(
g_general
)
=> t

Description

Sets the status of the auto rename feature to on or off. Earlier, the status of this feature was controlled only by a single time evaluation of the CDS_COPY_AUTO_RENAME shell environment variable. This environment variable defines the initial status setting for this feature. Now, this function allows you to change the status after the startup initialization.

Arguments

g_general

Enables the auto rename feature. When set to t, the CDS_COPY_AUTO_RENAME environment variable is set to YES.

Value Returned

t	Sets the current status of the auto rename feature to on or off.

Examples

If the ccpSetAutoRename function is set to t, the auto rename feature gets enabled. However, when the ccpSetAutoRename function is set to nil, the auto rename feature gets disabled.

; Calling ccpCopy with autorename mode switched to on.
    autoRenameWasOn = ccpGetAutoRename()
    if( !autoRenameWasOn  ccpSetAutoRename(t) )
    
    ok = ccpCopy( sourceGdmList destinationGdmList overwriteBoolean )
; Optional restoring autorename back to off for this example
    if( !autoRenameWasOn  ccpSetAutoRename(nil) )

Return to top