NAME

FFI::Platypus::Type::StringArray - Platypus custom type for arrays of strings

VERSION

version 0.01

SYNOPSIS

In your C code:

 void
 takes_string_array(const char **array)
 {
   ...
 }
 
 void
 takes_fixed_string_array(const char *array[5])
 {
   ...
 }

In your Platypus::FFI code:

 use FFI::Platypus::Declare
   'void',
   [ '::StringArray' => 'string_array' ],
   [ '::StringArray' => 'string_5' => 5 ];
 
 attach takes_string_array => [string_array] => void;
 attach takes_fixed_string_array => [string_5] => void;
 
 my @list = qw( foo bar baz );
 
 takes_string_array(\@list);
 takes_fixed_string_array([qw( s1 s2 s3 s4 s5 )]);

DESCRIPTION

This module provides a FFI::Platypus custom type for arrays of strings. The array is always NULL terminated. It is not (yet) supported as a return type.

This custom type takes two optional arguments. The first is the size of arrays and the second is a default value to fill in any values that aren't provided when the function is called. If not default is provided then NULL will be passed in for those values.

SEE ALSO

FFI::Platypus

FFI::Platypus::Type::StringPointer

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.