File: mongoc_apm_command_started_get_command.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 (37 lines) | stat: -rw-r--r-- 1,370 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
<?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_apm_command_started_get_command">

  <info>
    <link type="guide" xref="mongoc_apm_command_started_t" group="function"/>
  </info>
  <title>mongoc_apm_command_started_get_command()</title>

  <section id="synopsis">
    <title>Synopsis</title>
    <synopsis><code mime="text/x-csrc"><![CDATA[const bson_t *
mongoc_apm_command_started_get_command (const mongoc_apm_command_started_t *event);
]]></code></synopsis>
    <p>Returns this event's command. The data is only valid in the scope of the callback that receives this event; copy it if it will be accessed after the callback returns.</p>
    <p>See <link xref="application-performance-monitoring">Introduction to Application Performance Monitoring</link>.</p>
  </section>

  <section id="parameters">
    <title>Parameters</title>
    <table>
      <tr><td><p>event</p></td><td><p>A <code xref="mongoc_apm_command_started_t">mongoc_apm_command_started_t</code>.</p></td></tr>
    </table>
  </section>

  <section id="return">
    <title>Returns</title>
    <p>
A <code xref="bson:bson_t">bson_t</code> that should not be modified or freed.</p>
  </section>

</page>