File: error_conventions.rst

package info (click to toggle)
squirrel3 3.1-8.3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,380 kB
  • sloc: cpp: 12,722; ansic: 917; makefile: 316; python: 40
file content (16 lines) | stat: -rw-r--r-- 432 bytes parent folder | download | duplicates (12) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
.. _embedding_error_convetions:


========================
Error Conventions
========================

.. index::
    single: Error Conventions

Most of the functions in the API return a SQRESULT value; SQRESULT indicates if a
function completed successfully or not.
The macros SQ_SUCCEEDED() and SQ_FAILED() are used to test the result of a function.::

    if(SQ_FAILED(sq_getstring(v,-1,&s)))
        printf("getstring failed");