$Web Put Binary: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 4: | Line 4: | ||
<b>Note:</b> <var>$Web_Put_Bin</var> is a synonym for the <var>$Web_Put_Binary</var> function. | <b>Note:</b> <var>$Web_Put_Bin</var> is a synonym for the <var>$Web_Put_Binary</var> function. | ||
$Web_Put_Bin is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]). | |||
$Web_Put_Bin takes a single required string argument and returns a status code. | |||
==Syntax== | ==Syntax== | ||
Line 9: | Line 13: | ||
<section end="syntax" /></p> | <section end="syntax" /></p> | ||
<table class="syntaxTable"> | <table class="syntaxTable"> |
Revision as of 15:48, 19 September 2011
<section begin="desc" />$Web_Put_Binary: Add binary string to response buffer<section end="desc" />
$Web_Put_Binary sends a binary string to the client buffer.
Note: $Web_Put_Bin is a synonym for the $Web_Put_Binary function.
$Web_Put_Bin is a callable $function (see Calling Sirius Mods $functions).
$Web_Put_Bin takes a single required string argument and returns a status code.
Syntax
<section begin="syntax" /> %rc = $Web_Put_Binary( bin_string ) <section end="syntax" />
bin_string | A "binary" string that is added to the client buffer without any translation. Since the client buffer is always sent to the browser without translation, the binary contents of bin_string will be received by the browser. Under Sirius Mods Version 6.7 and later, $Web_Put_Bin is longstring capable: it can send a longstring with a length greater than 255 bytes. |
---|
Code | Meaning |
---|---|
0 | Binary string sent to the client buffer. |
-1 | Invalid call, not a Web thread |
-4 | Missing argument |
%X = $Web_Type('binary/jpeg') %X = $Web_Put_Bin( %COMPANYX_LOGO ) STOP
This sample shows a binary image in .jpg format being sent from a %variable to the client buffer (the image would have to be pretty small, given the 255 byte limitation on %variables).
Note that another way to send binary data is to store it in a Model 204 procedure and send it to the client using $Web_ProcSend.