<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 21:14:00 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[CDRIVER-2051] Documentation for several mongoc_uri_*() methods which return pointer types fail to state that NULL can be returned</title>
                <link>https://jira.mongodb.org/browse/CDRIVER-2051</link>
                <project id="10030" key="CDRIVER">C Driver</project>
                    <description>&lt;p&gt;From empirical testing and code inspection, it appears that a number of mongoc_uri_*() methods with pointer return types which are not documented to return NULL can indeed return NULL.&lt;/p&gt;

&lt;p&gt;The following is a list of all mongoc_uri_*() API functions from the 1.6.0 documentation, filtered down to exclude any function which either 1) doesn&apos;t return a pointer, or 2) is already documented to possibly return NULL.  Please determine the subset of API functions for which callers must check for NULL before assuming the returned pointer is valid, and update the documentation accordingly for the functions in that subset.&lt;/p&gt;
&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;mongoc_uri_copy()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_auth_mechanism()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_auth_source()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_database()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_hosts()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_mechanism_properties()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_option_as_utf8()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_options()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_password()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_read_concern()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_read_prefs()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_read_prefs_t()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_replica_set()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_string()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_username()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_get_write_concern()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_new_for_host_port()&lt;/li&gt;
	&lt;li&gt;mongoc_uri_unescape()&lt;/li&gt;
&lt;/ul&gt;
</description>
                <environment></environment>
        <key id="353665">CDRIVER-2051</key>
            <summary>Documentation for several mongoc_uri_*() methods which return pointer types fail to state that NULL can be returned</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Done</resolution>
                                        <assignee username="isabel.atkinson@mongodb.com">Isabel Atkinson</assignee>
                                    <reporter username="rassi">J Rassi</reporter>
                        <labels>
                            <label>neweng</label>
                    </labels>
                <created>Mon, 13 Feb 2017 23:30:06 +0000</created>
                <updated>Fri, 19 Jul 2019 20:29:14 +0000</updated>
                            <resolved>Thu, 20 Jun 2019 19:54:12 +0000</resolved>
                                                    <fixVersion>1.15.0</fixVersion>
                                    <component>docs</component>
                    <component>libmongoc</component>
                                        <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="2334805" author="jmikola@gmail.com" created="Fri, 19 Jul 2019 20:29:14 +0000"  >&lt;p&gt;Commit: &lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/d5a9ac7ef68312aac7b454f90c42ecf2f852648b&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/d5a9ac7ef68312aac7b454f90c42ecf2f852648b&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="343927">CXX-1187</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hsuxtr:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>