[thirdparty/openssl.git] / doc / man3 / OSSL_CMP_MSG_get0_header.pod

=pod

=head1 NAME

OSSL_CMP_MSG_get0_header
- function(s) manipulating CMP messages

=head1 SYNOPSIS

  #include <openssl/cmp.h>

  OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg);

=head1 DESCRIPTION

OSSL_CMP_MSG_get0_header returns the header of the given CMP message.

=head1 NOTES

CMP is defined in RFC 4210.

=head1 RETURN VALUES

CMP_MSG_get0_header() returns the intended pointer value as described above
or NULL if the respective entry does not exist and on error.

=head1 HISTORY

The OpenSSL CMP support was added in OpenSSL 3.0.

=head1 COPYRIGHT

Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
3dbc5156 DDO	1	=pod
	2
	3	=head1 NAME
	4
	5	OSSL_CMP_MSG_get0_header
	6	- function(s) manipulating CMP messages
	7
	8	=head1 SYNOPSIS
	9
	10	#include <openssl/cmp.h>
	11
	12	OSSL_CMP_PKIHEADER OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG msg);
	13
	14	=head1 DESCRIPTION
	15
	16	OSSL_CMP_MSG_get0_header returns the header of the given CMP message.
	17
	18	=head1 NOTES
	19
	20	CMP is defined in RFC 4210.
	21
	22	=head1 RETURN VALUES
	23
	24	CMP_MSG_get0_header() returns the intended pointer value as described above
	25	or NULL if the respective entry does not exist and on error.
	26
	27	=head1 HISTORY
	28
	29	The OpenSSL CMP support was added in OpenSSL 3.0.
	30
	31	=head1 COPYRIGHT
	32
	33	Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
	34
	35	Licensed under the Apache License 2.0 (the "License"). You may not use
	36	this file except in compliance with the License. You can obtain a copy
	37	in the file LICENSE in the source distribution or at
	38	L<https://www.openssl.org/source/license.html>.
	39
	40	=cut