view release on metacpan or  search on metacpan

lib/Crypt/PKCS11/CK_RC5_CBC_PARAMS.pod  view on Meta::CPAN

=encoding utf8

=head1 NAME

Crypt::PKCS11::CK_RC5_CBC_PARAMS - Perl interface to PKCS #11 CK_RC5_CBC_PARAMS structure

=head1 SYNPOSIS

  use Crypt::PKCS11::CK_RC5_CBC_PARAMS;
  my $obj = Crypt::PKCS11::CK_RC5_CBC_PARAMS->new;
  $obj->set...;
  $obj->get...;

=head1 DESCRIPTION

This is the Perl interface for the C structure CK_RC5_CBC_PARAMS in PKCS #11.
See PKCS #11 documentation for more information about the structure and what it
is used for.

=head1 METHODS

=over 4

=item $obj = Crypt::PKCS11::CK_RC5_CBC_PARAMS->new

Returns a new Crypt::PKCS11::CK_RC5_CBC_PARAMS object.

=item $rv = $obj->get_ulWordsize($ulWordsize)

Retrieve the value B<ulWordsize> from the structure into C<$ulWordsize>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $ulWordsize = $obj->ulWordsize

Returns the value B<ulWordsize> from the structure or undef on error.

=item $rv = $obj->set_ulWordsize($ulWordsize)

Set the value B<ulWordsize> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_ulRounds($ulRounds)

Retrieve the value B<ulRounds> from the structure into C<$ulRounds>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $ulRounds = $obj->ulRounds

Returns the value B<ulRounds> from the structure or undef on error.

=item $rv = $obj->set_ulRounds($ulRounds)

Set the value B<ulRounds> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $rv = $obj->get_pIv($pIv)

Retrieve the value B<pIv> from the structure into C<$pIv>.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=item $pIv = $obj->pIv

Returns the value B<pIv> from the structure or undef on error.

=item $rv = $obj->set_pIv($pIv)

Set the value B<pIv> in the structure.
Returns C<CKR_OK> on success otherwise a CKR describing the error.

=back

=head1 PRIVATE METHODS

These are the private methods used within the module and should not be used
elsewhere.

=over 4

=item $bytes = $obj->toBytes

Return the structure represented as bytes or undef on error.

=item $rv = $obj->fromBytes($bytes)

Sets the structure from a representation in bytes.
Returns C<CKR_OK> on success otherwise a CKR describing the error.