nf-certpol-icertpolicy-getdescription.md

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
NF:certpol.ICertPolicy.GetDescription	ICertPolicy::GetDescription (certpol.h)	Returns a human-readable description of the policy module and its function.	CCertPolicy object [Security] GetDescription method GetDescription GetDescription method [Security] GetDescription method [Security] CCertPolicy object GetDescription method [Security] ICertPolicy interface GetDescription method [Security] ICertPolicy2 interface ICertPolicy interface [Security] GetDescription method ICertPolicy.GetDescription ICertPolicy2 interface [Security] GetDescription method ICertPolicy2::GetDescription ICertPolicy::GetDescription _certsrv_icertpolicy_getdescription certpol/ICertPolicy2::GetDescription certpol/ICertPolicy::GetDescription security.icertpolicy2_getdescription	security\icertpolicy2_getdescription.htm	security	38b85fa8-f5e7-4ac8-9f38-1cad83417797	12/05/2018	CCertPolicy object [Security],GetDescription method, GetDescription, GetDescription method [Security], GetDescription method [Security],CCertPolicy object, GetDescription method [Security],ICertPolicy interface, GetDescription method [Security],ICertPolicy2 interface, ICertPolicy interface [Security],GetDescription method, ICertPolicy.GetDescription, ICertPolicy2 interface [Security],GetDescription method, ICertPolicy2::GetDescription, ICertPolicy::GetDescription, _certsrv_icertpolicy_getdescription, certpol/ICertPolicy2::GetDescription, certpol/ICertPolicy::GetDescription, security.icertpolicy2_getdescription	certpol.h	Certsrv.h	Windows	None supported	Windows Server 2003 [desktop apps only]										Certidl.lib			Windows			19H1	ICertPolicy::GetDescription certpol/ICertPolicy::GetDescription	c++	APIRef kbSyntax	COM	Certidl.lib Certidl.dll	ICertPolicy2.GetDescription ICertPolicy.GetDescription CCertPolicy.GetDescription

ICertPolicy::GetDescription

-description

The GetDescription method returns a human-readable description of the policy module and its function.

-parameters

-param pstrDescription [out]

A pointer to a BSTR that describes the policy module.

-returns

C++

If the method succeeds, the method returns S_OK.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

VB

Returns a string that describes the policy module and its function.

-remarks

When you write custom policy modules, implement this method.

Examples

#include <windows.h>
#include <Certpol.h>

STDMETHODIMP CCertPolicy::GetDescription(
    /* [out, retval] */ BSTR __RPC_FAR *pstrDescription)
{
    if (NULL == pstrDescription)
    {
        // Bad pointer address
        return ( E_POINTER );
    }
    if (NULL != *pstrDescription)
    {
        SysFreeString(*pstrDescription);
        *pstrDescription=NULL;
    }
    // wszMyModuleDesc defined elsewhere, for example:
    // #define wszMyModuleDesc L"My Policy Module"
    *pstrDescription = SysAllocString(wszMyModuleDesc);
    if (NULL == *pstrDescription)
    {
        // Not enough memory
        return ( E_OUTOFMEMORY );
    }
    // Success
    return( S_OK );
}

-see-also

ICertPolicy

ICertPolicy2