authorgravatar for klapatchaaron@gmail.comAaron Klapatch <klapatchaaron@gmail.com> 2019-08-19 15:47:16-05:00
committergravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2019-08-19 16:47:16-04:00
logefc2237e5a545fac94ecc9c9757d202bda322abd
tree79351fae4e7b432f963b17a26dbbe1c3f5ae649d
parentd067a037cce906d600851e9b88df251451f9a93e

added documentation for field access to C pointers (#3088)

1 files changed, 7 insertions(+), 0 deletions(-)

doc/langref.html.in+7
......@@ -9322,6 +9322,13 @@ const c = @cImport({
93229322 <li>Does not support Zig-only pointer attributes such as alignment. Use normal {#link|Pointers#}
93239323 please!</li>
93249324 </ul>
9325 <p>When a C pointer is pointing to a single struct (not an array), deference the C pointer to
9326 access to the struct's fields or member data. That syntax looks like
9327 this: </p>
9328 <p>{#syntax#}ptr_to_struct.*.struct_member{#endsyntax#}</p>
9329 <p>This is comparable to doing {#syntax#}->{#endsyntax#} in C.</p>
9330 <p> When a C pointer is pointing to an array of structs, the syntax reverts to this:</p>
9331 <p>{#syntax#}ptr_to_struct_array[index].struct_member{#endsyntax#}</p>
93259332 {#header_close#}
93269333
93279334 {#header_open|Exporting a C Library#}