File: mongoc_write_concern_append.page

package info (click to toggle)
libmongoc 1.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,824 kB
  • ctags: 4,501
  • sloc: ansic: 57,956; makefile: 717; python: 502; sh: 54
file content (41 lines) | stat: -rw-r--r-- 2,796 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?xml version="1.0"?>            
<page xmlns="http://projectmallard.org/1.0/" 
      type="topic"                          
      style="function"                     
      xmlns:api="http://projectmallard.org/experimental/api/" 
      xmlns:ui="http://projectmallard.org/experimental/ui/"  
      id="mongoc_write_concern_append">                     
  <info>                                                   
    <link type="guide" xref="mongoc_write_concern_t" group="function"/>
  </info>                                                             
  <title>mongoc_write_concern_append()</title>                       
                                                                    
  <section id="synopsis">                                          
    <title>Synopsis</title>                                       
    <synopsis><code mime="text/x-csrc"><![CDATA[bool
mongoc_write_concern_append (mongoc_write_concern_t *write_concern,
                             bson_t                 *command);    
]]></code></synopsis>                                            
  </section>                                                    
                                                               
                                                              
  <section id="parameters">                                  
    <title>Parameters</title>                               
    <table>                                                
      <tr><td><p>write_concern</p></td><td><p>A pointer to a <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code>.</p></td></tr>
      <tr><td><p>command</p></td><td><p>A pointer to a <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
    </table>                                              
  </section>                                                           
                                                                      
  <section id="description">                                         
    <title>Description</title>                                      
    <p>This function appends a valid write concern to a command. It is useful for appending a write concern to a command before passing it to a generic command function like <code xref="mongoc_client_command_simple">mongoc_client_command_simple</code>.</p>
  </section>                                                  
                                                             
  <section id="return">                                     
    <title>Returns</title>                                 
    <p>Returns true on success, and false otherwise.</p>
  </section>                                              
                                                         
                                                        
</page>