Admin: 1 revision

2013-02-15T19:15:24Z

1 revision

Admin: Created page with "= Action = Copies a block of memory =
2013-02-11T20:39:54Z

Created page with "= Action = Copies a block of memory = Action =

Copies a block of memory

 

 

= Syntax =

bts = MEMCOPY(source, target , bytes[ , option])

 

 

= Remarks =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="604" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
bts

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
The total number of bytes copied. This must be a word or integer

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
source

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
The first address of the source variable that will be copied.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
target

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
The first address of the target variable that will be copied to.

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
bytes

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
The number of bytes to copy from "source" to "target"

|- style="vertical-align: top;"
| valign="top" width="15%" style="width: 87px; border: 1px solid rgb(0, 0, 0);" |
option

| valign="top" width="100%" style="width: 508px; border: 1px solid rgb(0, 0, 0);" |
An optional numeric constant with one of the following values :

1 - only the source address will be increased after each copied byte

2 - only the target address will be increased after each copied byte

3 - both the source and target address will be copied after each copied byte

|}
</div>
 

By default, option 3 is used as this will copy a block of memory from one memory location to another location. But it also possible to fill an entire array of memory block with the value of 1 memory location. For example to clear a whole block or preset it with a value.

And with option 2, you can for example get a number of samples from a register like PINB and store it into an array.

 

MEMCOPY checks the size of the target variable and it will not overwrite data if the number of bytes is greater than the size of the target data. For example :

Dim tar(4) as byte, sar(8) as byte

MEMCOPY sar(1), tar(1),8

Even while 8 bytes are specified, the data size for tar() is 4 and thus only 4 bytes will be copied.

 

When you use MEMCOPY Inside a sub routine/function with passed parameters, there is no way to check the target size.

In this case, there is no check on the target size and the number of specified bytes will be moved, no matter the target data size.

 

MEMCOPY can also be used to clear an array quickly.

 

 

= See also =

NONE

 

 

= ASM =

NONE

 

 

= Example =

 <source lang="bascomavr">
'-----------------------------------------------------------------------
'name : MEMCOPY.BAS
'copyright : (c) 1995-2006, MCS Electronics
'purpose : show memory copy function
'suited for demo : yes
'commercial addon needed : no
'use in simulator : possible
'----------------------------------------------------------------------
$regfile = "m88def.dat" ' specify the used micro
$crystal = 8000000 ' used crystal frequency
$baud = 19200 ' use baud rate
$hwstack = 32 ' default use 32 for the hardware stack
$swstack = 16 ' default use 10 for the SW stack
$framesize = 40

Dim Ars(10) As Byte 'source bytes
Dim Art(10) As Byte 'target bytes
Dim J As Byte 'index
For J = 1 To 10 'fill array
Ars(j) = J
Next

J = Memcopy(ars(1) , Art(1) , 4) 'copy 4 bytes

Print J ; " bytes copied"
For J = 1 To 10
Print Art(j)
Next

J = Memcopy(ars(1) , Art(1) , 10 , 2) 'assign them all with element 1

Print J ; " bytes copied"
For J = 1 To 10
Print Art(j)
Next

Dim W As Word , L As Long
W = 65511
J = Memcopy(w , L , 2) 'copy 2 bytes from word to long
End
</source> {{Languages}}

[[Category:BASCOM Language Reference/de]]