Skip to content

Latest commit

 

History

History
98 lines (76 loc) · 4.08 KB

nc-wincrypt-pfn_cmsg_export_mail_list.md

File metadata and controls

98 lines (76 loc) · 4.08 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NC:wincrypt.PFN_CMSG_EXPORT_MAIL_LIST
PFN_CMSG_EXPORT_MAIL_LIST (wincrypt.h)
Encrypts and exports the content encryption key for a mailing list recipient of an enveloped message.
PFN_CMSG_EXPORT_MAIL_LIST
PFN_CMSG_EXPORT_MAIL_LIST callback
PFN_CMSG_EXPORT_MAIL_LIST callback function [Security]
security.pfn_cmsg_export_mail_list
wincrypt/PFN_CMSG_EXPORT_MAIL_LIST
security\pfn_cmsg_export_mail_list.htm
security
68a75714-cf47-40f9-95ab-e1ffc8936390
12/05/2018
PFN_CMSG_EXPORT_MAIL_LIST, PFN_CMSG_EXPORT_MAIL_LIST callback, PFN_CMSG_EXPORT_MAIL_LIST callback function [Security], security.pfn_cmsg_export_mail_list, wincrypt/PFN_CMSG_EXPORT_MAIL_LIST
wincrypt.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Windows
19H1
PFN_CMSG_EXPORT_MAIL_LIST
wincrypt/PFN_CMSG_EXPORT_MAIL_LIST
c++
APIRef
kbSyntax
UserDefined
Wincrypt.h
PFN_CMSG_EXPORT_MAIL_LIST

PFN_CMSG_EXPORT_MAIL_LIST callback function

-description

The PFN_CMSG_EXPORT_MAIL_LIST callback function encrypts and exports the content encryption key for a mailing list recipient of an enveloped message. PFN_CMSG_EXPORT_MAIL_LIST can be installed by using a CryptoAPI object identifier (OID). This function is called by the CryptMsgOpenToEncode function when its dwMsgType parameter is set to CMSG_ENVELOPED.

-parameters

-param pContentEncryptInfo [in]

A pointer to a CMSG_CONTENT_ENCRYPT_INFO structure that contains the content encryption key.

-param pMailListEncodeInfo [in]

A pointer to a CMSG_MAIL_LIST_RECIPIENT_ENCODE_INFO structure that specifies the key used to encrypt the content encryption key.

-param pMailListEncryptInfo [in, out]

A pointer to a CMSG_MAIL_LIST_ENCRYPT_INFO structure that contains the encrypted content encryption key.

-param dwFlags [in]

This value is not used. Set it to zero.

-param pvReserved

This parameter is reserved and must be NULL.

-returns

If the function succeeds, the return value is nonzero (TRUE).

If the function fails, the return value is zero (FALSE). For extended error information, call GetLastError.

-remarks

The PFN_CMSG_EXPORT_MAIL_LIST function must update the EncryptedKey member of the CMSG_MAIL_LIST_ENCRYPT_INFO structure pointed to by the pMailListEncryptInfo parameter. This function must use the pfnAlloc and pfnFree members of the CMSG_CONTENT_ENCRYPT_INFO structure pointed to by the pContentEncryptInfo parameter to manage memory for any values that it updates.

You can use OID Support Functions to deploy this callback function. Wincrypt.h defines the following constants for this purpose.

Constant Definition
CMSG_OID_EXPORT_MAIL_LIST_FUNC or CMSG_OID_CAPI1_EXPORT_MAIL_LIST_FUNC "CryptMsgDllExportMailList"