Changeset 785:7eb7d3e740e7 in roaraudio for doc


Ignore:
Timestamp:
09/17/08 02:32:13 (16 years ago)
Author:
phi
Branch:
default
Phase:
public
Message:

added infos about pointer, added "THREAD SAFETY"

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/man3/roar_str2codec.3

    r784 r785  
    2323Note that because of aliasing and case insensitivity the revers operation needs not to be true. 
    2424 
     25.SH "THREAD SAFETY" 
     26Because \fBroar_codec2str\fR returns a static unique pointer for each codec it is fully thread safe. 
     27 
    2528.SH "RETURN VALUE" 
    2629On success \fBroar_str2codec\fR returns a codec ID.  On error, -1 is returned. 
    2730\fBroar_codec2str\fR returns the name of the codec or NULL on error. 
     31You must not free this pointer or write to it. 
    2832 
    2933.SH "EXAMPLES" 
Note: See TracChangeset for help on using the changeset viewer.