1*b077aed3SPierre Pronchery=pod 2*b077aed3SPierre Pronchery 3*b077aed3SPierre Pronchery=head1 NAME 4*b077aed3SPierre Pronchery 5*b077aed3SPierre ProncheryOSSL_ITEM - OpenSSL Core type for generic itemized data 6*b077aed3SPierre Pronchery 7*b077aed3SPierre Pronchery=head1 SYNOPSIS 8*b077aed3SPierre Pronchery 9*b077aed3SPierre Pronchery #include <openssl/core.h> 10*b077aed3SPierre Pronchery 11*b077aed3SPierre Pronchery typedef struct ossl_item_st OSSL_ITEM; 12*b077aed3SPierre Pronchery struct ossl_item_st { 13*b077aed3SPierre Pronchery unsigned int id; 14*b077aed3SPierre Pronchery void *ptr; 15*b077aed3SPierre Pronchery }; 16*b077aed3SPierre Pronchery 17*b077aed3SPierre Pronchery=head1 DESCRIPTION 18*b077aed3SPierre Pronchery 19*b077aed3SPierre ProncheryThis type is a tuple of integer and pointer. 20*b077aed3SPierre ProncheryIt's a generic type used as a generic descriptor, its exact meaning 21*b077aed3SPierre Proncherybeing defined by how it's used. 22*b077aed3SPierre ProncheryArrays of this type are passed between the OpenSSL libraries and the 23*b077aed3SPierre Proncheryproviders, and must be terminated with a tuple where the integer is 24*b077aed3SPierre Proncheryzero and the pointer NULL. 25*b077aed3SPierre Pronchery 26*b077aed3SPierre ProncheryThis is currently mainly used for the return value of the provider's error 27*b077aed3SPierre Proncheryreason strings array, see L<provider-base(7)/Provider Functions>. 28*b077aed3SPierre Pronchery 29*b077aed3SPierre Pronchery=begin comment RETURN VALUES doesn't make sense for a manual that only 30*b077aed3SPierre Proncherydescribes a type, but document checkers still want that section, and 31*b077aed3SPierre Proncheryto have more than just the section title. 32*b077aed3SPierre Pronchery 33*b077aed3SPierre Pronchery=head1 RETURN VALUES 34*b077aed3SPierre Pronchery 35*b077aed3SPierre Proncherytxt 36*b077aed3SPierre Pronchery 37*b077aed3SPierre Pronchery=end comment 38*b077aed3SPierre Pronchery 39*b077aed3SPierre Pronchery=head1 SEE ALSO 40*b077aed3SPierre Pronchery 41*b077aed3SPierre ProncheryL<crypto(7)>, L<provider-base(7)>, L<openssl-core.h(7)> 42*b077aed3SPierre Pronchery 43*b077aed3SPierre Pronchery=head1 HISTORY 44*b077aed3SPierre Pronchery 45*b077aed3SPierre ProncheryB<OSSL_ITEM> was added in OpenSSL 3.0 46*b077aed3SPierre Pronchery 47*b077aed3SPierre Pronchery=head1 COPYRIGHT 48*b077aed3SPierre Pronchery 49*b077aed3SPierre ProncheryCopyright 2022 The OpenSSL Project Authors. All Rights Reserved. 50*b077aed3SPierre Pronchery 51*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License"). You may not use 52*b077aed3SPierre Proncherythis file except in compliance with the License. You can obtain a copy 53*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at 54*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>. 55*b077aed3SPierre Pronchery 56*b077aed3SPierre Pronchery=cut 57