Core Function BinaryReplace

From Sputnik Wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
<pre>
 
<pre>
BinaryReplace( <binary-array>, <needle>, <replacement>, <maxReplacements> )
+
BinaryReplace( <binary-array>, <needle>, <replacement>, <offset>, <maxReplacements> )
 
</pre>
 
</pre>
  
Line 24: Line 24:
  
 
(It will be cast as binary if it isn't already)
 
(It will be cast as binary if it isn't already)
 +
 +
==== offset ====
 +
 +
Optional; Position to begin the search
 +
 +
Default: 0 (beginning)
  
 
==== maxReplacements ====
 
==== maxReplacements ====
  
 
Optional; The max allowed replacements to do
 
Optional; The max allowed replacements to do
 +
 +
Default: -1  (replace all)
  
 
=== Return Value ===
 
=== Return Value ===
Line 115: Line 123:
  
 
// Do the replacement
 
// Do the replacement
BinaryReplace($subject, $find, $replace, 1);
+
BinaryReplace($subject, $find, $replace, 0, 1);
  
 
// Print changed
 
// Print changed
Line 135: Line 143:
  
 
// Do the replacement
 
// Do the replacement
BinaryReplace($subject, $find, $replace, 1);
+
BinaryReplace($subject, $find, $replace, 0, 1);
  
 
// Print changed
 
// Print changed

Revision as of 07:01, 11 August 2014

BinaryReplace( <binary-array>, <needle>, <replacement>, <offset>, <maxReplacements> )

Contents

Description

Search for a byte or string of bytes in a binary variable and replace it.

Parameters

binary-array

The binary variable to do the replacement on.

needle

The needle to find.

(It will be cast as binary if it isn't already)

replacement

The replacement to use.

(It will be cast as binary if it isn't already)

offset

Optional; Position to begin the search

Default: 0 (beginning)

maxReplacements

Optional; The max allowed replacements to do

Default: -1 (replace all)

Return Value

Success: Returns true.

Failure: Returns false.

Remarks

None.

Example

Simple replacement

// Assign a value to do the replace on
$subject = Pack("A*", "Hello world!!!");
// Assign a value to find
$find = Pack("A*", "world");
// Assign a value to replace the found with
$replace = Pack("A*", "cat");
 
// Print unchanged
say $subject; // Hello world!!!
 
// Do the replacement
BinaryReplace($subject, $find, $replace);
 
// Print changed
say $subject; // Hello cat!!!

This time the replacement is bigger than what is being replaced

// Assign a value to do the replace on
$subject = Pack("A*", "Hello world!!!");
// Assign a value to find
$find = Pack("A*", "world");
// Assign a value to replace the found with
$replace = Pack("A*", "Spuntik");
 
// Print unchanged
say $subject; // Hello world!!!
 
// Do the replacement
BinaryReplace($subject, $find, $replace);
 
// Print changed
say $subject; // Hello Spuntik!!!

Of course it will replace all it finds

// Assign a value to do the replace on
$subject = Pack("A*", "Hello world ok world hehe world!!!");
// Assign a value to find
$find = Pack("A*", "world");
// Assign a value to replace the found with
$replace = Pack("A*", "Spuntik");
 
// Print unchanged
say $subject; // Hello world ok world hehe world!!!
 
// Do the replacement
BinaryReplace($subject, $find, $replace);
 
// Print changed
say $subject; // Hello Spuntik ok Spuntik hehe Spuntik!!!

Only allow one replacement

// Assign a value to do the replace on
$subject = Pack("A*", "Hello world ok world hehe world!!!");
// Assign a value to find
$find = Pack("A*", "world");
// Assign a value to replace the found with
$replace = Pack("A*", "Spuntik");
 
// Print unchanged
say $subject; // Hello world ok world hehe world!!!
 
// Do the replacement
BinaryReplace($subject, $find, $replace, 0, 1);
 
// Print changed
say $subject; // Hello Spuntik ok world hehe world!!!

Only allow two replacements

// Assign a value to do the replace on
$subject = Pack("A*", "Hello world ok world hehe world!!!");
// Assign a value to find
$find = Pack("A*", "world");
// Assign a value to replace the found with
$replace = Pack("A*", "Spuntik");
 
// Print unchanged
say $subject; // Hello world ok world hehe world!!!
 
// Do the replacement
BinaryReplace($subject, $find, $replace, 0, 1);
 
// Print changed
say $subject; // Hello Spuntik ok Spuntik hehe world!!!
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox