Template:ApiBinaryItem: Difference between revisions

From ADVACAM Wiki
Jump to navigation Jump to search
(Template for documentation of the binary(C) API functions)
 
No edit summary
 
(64 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Summary'''<br>
{{{HeSym}}} {{{Nam}}} {{{HeSym}}}
{{{Sum}}}
{{#switch: {{{HeSym}}} | {{=}} =  | {{=}}{{=}} =  | ---- }}
<br>
<noinclude><br>HeSym = Header symbol - ====, Nam = function name to using in header and definition<br>
'''Definition'''<br>
Creates chapter header and adds line if HeSym is not = or ==
{{{Def}}}
</noinclude>
<br>
:{{{Sum}}}
 
;Definition
:{{#tag:syntaxhighlight
|{{{DefH}}} {{{Nam}}}({{{DefP}}});
|lang=C
}}
<noinclude>:{{{DefH}}} '''{{{Nam}}}'''({{{DefP}}});<noinclude>
<noinclude><br>DefH = definition header - int, DefP = definition parameters - char*msg, int len<br></noinclude>
'''Parameters'''<br>
'''Parameters'''<br>
# {{{1}}}
{{#if: {{{1}}} |* {{{1}}} |: (no pars)}}
# {{{2}}}
* {{{2}}}
# {{{3}}}
* {{{3}}}
# {{{4}}}
* {{{4}}}
# {{{5}}}
* {{{5}}}
# {{{6}}}
* {{{6}}}
# {{{7}}}
* {{{7}}}
# {{{8}}}
* {{{8}}}
# {{{9}}}
;Return value
# {{{10}}}
:{{{Ret}}}
<br>
{{#if: {{{Not}}} | '''Note'''<br>| }}
'''Return value'''<br>
: {{{Not}}}
{{{Ret}}}
{{#if: {{{War}}} | '''Warning'''<br>| }}
<br>
: {{{War}}}
'''Note'''<br>
{{#if: {{{Exa}}} | '''Example'''<br> {{#tag:syntaxhighlight
{{{Not}}}
|{{{Exa}}}
|line
|lang=C
}}<br> | }}

Latest revision as of 18:07, 29 June 2023

{{{HeSym}}} {{{Nam}}} {{{HeSym}}}



HeSym = Header symbol - ====, Nam = function name to using in header and definition
Creates chapter header and adds line if HeSym is not = or ==

{{{Sum}}}
Definition
{{{DefH}}} {{{Nam}}}({{{DefP}}});
{{{DefH}}} {{{Nam}}}({{{DefP}}});


DefH = definition header - int, DefP = definition parameters - char*msg, int len
Parameters

  • {{{1}}}
  • {{{2}}}
  • {{{3}}}
  • {{{4}}}
  • {{{5}}}
  • {{{6}}}
  • {{{7}}}
  • {{{8}}}
Return value
{{{Ret}}}

Note

{{{Not}}}

Warning

{{{War}}}

Example

{{{Exa}}}