.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FFI::Platypus::Type::PointerSizeBuffer 3pm"
.TH FFI::Platypus::Type::PointerSizeBuffer 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
FFI::Platypus::Type::PointerSizeBuffer \- Convert string scalar to a buffer as a pointer / size_t combination
.SH VERSION
.IX Header "VERSION"
version 2.08
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In your C code:
.PP
.Vb 5
\& void
\& function_with_buffer(void *pointer, size_t size)
\& {
\&   ...
\& }
.Ve
.PP
In your Platypus::FFI code:
.PP
.Vb 1
\& use FFI::Platypus 2.00;
\& 
\& my $ffi = FFI::Platypus\->new( api => 2 );
\& $ffi\->load_custom_type(\*(Aq::PointerSizeBuffer\*(Aq => \*(Aqbuffer\*(Aq);
\& 
\& $ffi\->attach(function_with_buffer => [\*(Aqbuffer\*(Aq] => \*(Aqvoid\*(Aq);
\& my $string = "content of buffer";
\& function_with_buffer($string);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A common pattern in C code is to pass in a region of memory as a buffer,
consisting of a pointer and a size of the memory region.  In Perl,
string scalars also point to a contiguous series of bytes that has a
size, so when interfacing with C libraries it is handy to be able to
pass in a string scalar as a pointer / size buffer pair.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP FFI::Platypus 4
.IX Item "FFI::Platypus"
Main Platypus documentation.
.IP FFI::Platypus::Type 4
.IX Item "FFI::Platypus::Type"
Platypus types documentation.
.SH AUTHOR
.IX Header "AUTHOR"
Author: Graham Ollis <plicease@cpan.org>
.PP
Contributors:
.PP
Bakkiaraj Murugesan (bakkiaraj)
.PP
Dylan Cali (calid)
.PP
pipcet
.PP
Zaki Mughal (zmughal)
.PP
Fitz Elliott (felliott)
.PP
Vickenty Fesunov (vyf)
.PP
Gregor Herrmann (gregoa)
.PP
Shlomi Fish (shlomif)
.PP
Damyan Ivanov
.PP
Ilya Pavlov (Ilya33)
.PP
Petr Písař (ppisar)
.PP
Mohammad S Anwar (MANWAR)
.PP
Håkon Hægland (hakonhagland, HAKONH)
.PP
Meredith (merrilymeredith, MHOWARD)
.PP
Diab Jerius (DJERIUS)
.PP
Eric Brine (IKEGAMI)
.PP
szTheory
.PP
José Joaquín Atria (JJATRIA)
.PP
Pete Houston (openstrike, HOUSTON)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015\-2022 by Graham Ollis.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.