lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-04-03 10:16:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

Publish!

Browse Source 
Generated from v6.0.11315.11111-test10
This commit is contained in:
Bozo
2018-01-26 04:54:48 -08:00
parent 2ea16cc86c
commit 55446d56ce
1111 changed files with 7129 additions and 10641 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
6/d2/d3b/class_o_n___string.html
View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: ON_String Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -22,6 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">openNURBS SDK Help
&#160;<span id="projectnumber">6.0</span>
</div>
</td>
</tr>
@@ -29,21 +30,18 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -1199,8 +1197,7 @@ Protected Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Compare this string and other_name as a name attribute of an object like <a class="el" href="../../d0/d52/class_o_n__3dm_object_attributes.html#a0c2eb894357b6a7b5b3f7b354ebe05de">ON_3dmObjectAttributes.m_name</a>, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization. <br />
Parameters: other_name - [in] null terminated string </p>
<p>Description: Compare this string and other_name as a name attribute of an object like <a class="el" href="../../d0/d52/class_o_n__3dm_object_attributes.html#a0c2eb894357b6a7b5b3f7b354ebe05de">ON_3dmObjectAttributes.m_name</a>, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization. Parameters: other_name - [in] null terminated string </p>
</div>
</div>
@@ -1237,8 +1234,7 @@ Parameters: other_name - [in] null terminated string </p>
</tr>
</table>
</div><div class="memdoc">
<p>Description: Compare this string and other_name as a name attribute of an object like <a class="el" href="../../d0/d52/class_o_n__3dm_object_attributes.html#a0c2eb894357b6a7b5b3f7b354ebe05de">ON_3dmObjectAttributes.m_name</a>, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization. <br />
Parameters: name1 - [in] null terminated string name2 - [in] null terminated string </p>
<p>Description: Compare this string and other_name as a name attribute of an object like <a class="el" href="../../d0/d52/class_o_n__3dm_object_attributes.html#a0c2eb894357b6a7b5b3f7b354ebe05de">ON_3dmObjectAttributes.m_name</a>, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization. Parameters: name1 - [in] null terminated string name2 - [in] null terminated string </p>
</div>
</div>
@@ -2466,8 +2462,7 @@ Parameters: name1 - [in] null terminated string name2 - [in] null terminated str
</tr>
</table>
</div><div class="memdoc">
<p>Parameters: format - [in] Format control. <br />
Positional paramters of the form N$x where N &gt;= 1 and x is the standard format specification are supported. Avoid using S (capital S). See the Remarks for details. ... - [in] arguments for replacable items in the format string. Returns: True if successful. False if the string is too long or the format string is not valid. Remarks: When using Microsoft's compiler and other compilers that provide similar locale support, the locale is the invariant culture locale returned by ON_Locale::InvariantCulture::LocalePtr().</p>
<p>Parameters: format - [in] Format control. Positional paramters of the form N$x where N &gt;= 1 and x is the standard format specification are supported. Avoid using S (capital S). See the Remarks for details. ... - [in] arguments for replacable items in the format string. Returns: True if successful. False if the string is too long or the format string is not valid. Remarks: When using Microsoft's compiler and other compilers that provide similar locale support, the locale is the invariant culture locale returned by ON_Locale::InvariantCulture::LocalePtr().</p>
<p>The way Windows handles the S (capital S) format parameter depends on locale and code page settings. It is strongly reccommended that you never use S to include any string that may possibly contain elements with values &gt; 127. The following examples illustrate a way to predictably use UTF-8 and wchar_t parameters in buffers of the other element type.</p>
<p>const char* utf8_string = ...; / UNRELIABLE ///&lt; <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(buffer,buffer_capacity,"%S",utf8_string); / The code below will treat utf8_string as a UTF-8 encoded string. wchar_t wchar_buffer[...]; const size_t wchar_buffer_capacity= sizeof(buffer)/sizeof(buffer[0]); <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(wchar_buffer, wchar_buffer_capacity, "%s", <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString(utf8_string)</a>);</p>
<p>const wchar_t* wide_string = ...; / UNRELIABLE ///&lt; <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(buffer,buffer_capacity,"%S",char_string); / The code below will include wide_string as a UTF-8 encoded string. char char_buffer[...]; const size_t char_buffer_capacity = sizeof(buffer)/sizeof(buffer[0]); <a class="el" href="../../d2/d3b/class_o_n___string.html#ad091f25b0e421c9cc1bf0ebd24b91d3b">ON_String::Format</a>(char_buffer, char_buffer_capacity, "%s", <a class="el" href="../../d2/d3b/class_o_n___string.html">ON_String(wide_string)</a>); </p>
@@ -2547,8 +2542,7 @@ Parameters: name1 - [in] null terminated string name2 - [in] null terminated str
</tr>
</table>
</div><div class="memdoc">
<p>Description: A platform independent, secure, culture invariant way to format a char string. This function is provide to be used when it is critical that the formatting be platform independent, secure and culture invarient. Parameters: buffer - [out] not null buffer_capacity - [in] &gt; 0 Number of char elements in buffer. sFormat - [in] Avoid using S (capital S). See the Remarks for details. ... - [in] Returns: &gt;= 0: The number of char elements written to buffer[], not including the null terminator. A null terminator is always added (buffer[returned value] = 0). The last element of buffer[] is always set to zero (buffer[buffer_capacity-1] = 0). &lt; 0: failure: If buffer is not null and buffer_capacity &gt; 0, then buffer[0] = 0 and buffer[buffer_capacity-1] = 0; Remarks: The way Windows handles the S (capital S) format parameter depends on locale and code page settings. It is strongly reccommended that you never use S to include any string that may possibly contain elements with values &gt; 127. <br />
The following examples illustrate a way to predictably use UTF-8 and wchar_t parameters in buffers of the other element type. </p><pre class="fragment"> const char* utf8_string = ...;
<p>Description: A platform independent, secure, culture invariant way to format a char string. This function is provide to be used when it is critical that the formatting be platform independent, secure and culture invarient. Parameters: buffer - [out] not null buffer_capacity - [in] &gt; 0 Number of char elements in buffer. sFormat - [in] Avoid using S (capital S). See the Remarks for details. ... - [in] Returns: &gt;= 0: The number of char elements written to buffer[], not including the null terminator. A null terminator is always added (buffer[returned value] = 0). The last element of buffer[] is always set to zero (buffer[buffer_capacity-1] = 0). &lt; 0: failure: If buffer is not null and buffer_capacity &gt; 0, then buffer[0] = 0 and buffer[buffer_capacity-1] = 0; Remarks: The way Windows handles the S (capital S) format parameter depends on locale and code page settings. It is strongly reccommended that you never use S to include any string that may possibly contain elements with values &gt; 127. The following examples illustrate a way to predictably use UTF-8 and wchar_t parameters in buffers of the other element type. </p><pre class="fragment"> const char* utf8_string = ...;
</pre><p> / UNRELIABLE ///&lt; <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(buffer,buffer_capacity,"%S",utf8_string); wchar_t wchar_buffer[...]; const size_t wchar_buffer_capacity= sizeof(buffer)/sizeof(buffer[0]); <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(wchar_buffer, wchar_buffer_capacity, "%s", <a class="el" href="../../d1/d11/class_o_n__w_string.html">ON_wString(utf8_string)</a>);</p>
<p>const wchar_t* wide_string = ...; / UNRELIABLE ///&lt; <a class="el" href="../../d1/d11/class_o_n__w_string.html#a31d91a70bc08ca4de9a83b2419690967">ON_wString::Format</a>(buffer,buffer_capacity,"%S",char_string); char char_buffer[...]; const size_t char_buffer_capacity = sizeof(buffer)/sizeof(buffer[0]); <a class="el" href="../../d2/d3b/class_o_n___string.html#ad091f25b0e421c9cc1bf0ebd24b91d3b">ON_String::Format</a>(char_buffer, char_buffer_capacity, "%s", <a class="el" href="../../d2/d3b/class_o_n___string.html">ON_String(wide_string)</a>); </p>
@@ -3394,8 +3388,7 @@ Parameters: name1 - [in] null terminated string name2 - [in] null terminated str
</tr>
</table>
</div><div class="memdoc">
<p>Description: Map a single byte UTF-8 element to upper or lower case. Parameters: c - [in] If c is in the range A to Z or a to z, the map specified by map_type is applied. All other values of c are unchanged. <br />
Remarks: MapCharacterOrdinal is not appropriate for general string mapping. </p>
<p>Description: Map a single byte UTF-8 element to upper or lower case. Parameters: c - [in] If c is in the range A to Z or a to z, the map specified by map_type is applied. All other values of c are unchanged. Remarks: MapCharacterOrdinal is not appropriate for general string mapping. </p>
</div>
</div>
@@ -3540,8 +3533,8 @@ Remarks: MapCharacterOrdinal is not appropriate for general string mapping. </p>
<p>If element_count &lt; 1, then string[] must be null terminated and ON_wString::Length(string)+1 elements are mapped. The +1 insures the output is null terminated.</p>
<p>mapped_string - [out] The result of the mapping is returned in mapped_string[].</p>
<p>mapped_string_capacity - [in] Number of char elements available in mapped_string[] or 0 to calculate the minimum number of elements needed for the mapping.</p>
<p>Returns: If mapped_string_capacity &gt; 0, then the number elements set in mapped_string[] is returned. <br />
If mapped_string_capacity == 0, then the number elements required to perform the mapping is returned.</p>
<p>Returns: If mapped_string_capacity &gt; 0, then the number elements set in mapped_string[] is returned.</p>
<p>If mapped_string_capacity == 0, then the number elements required to perform the mapping is returned.</p>
<p>When there is room, mapped_string[] is null terminated.</p>
<p>0: Failure. </p>
@@ -5792,9 +5785,9 @@ Remarks: MapCharacterOrdinal is not appropriate for general string mapping. </p>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 26 2018 12:38:23 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Jan 26 2018 04:54:33 for openNURBS SDK Help by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.14
</a> 1.8.13
</small></address>
</body>
</html>