ICertManageModule::GetDescription

[This is preliminary documentation and subject to change.]

The GetDescription method retrieves the description of the module.

[VB] String GetDescription();
 
[JAVA] java.lang.String GetDescription();
 
[C++] HRESULT GetDescription(
  BSTR *pstrDesc         // out
);

Parameters

[C++] pstrDesc

Pointer to a BSTR type that will contain the module description. The GetDescription method fails if pstrDesc is NULL. It is the caller's responsibility to call SysFreeString when done with pstrDesc.

Return Values

[VB][JAVA] The return value is a String representing the module description.

[C++] The return value is an HRESULT. A value of S_OK indicates success.

Remarks

The GetDescription method is used to retrieve the description of the module.

Example

HRESULT   hr;
BSTR      bstrDesc = NULL;

// pIManageModule is previously instantiated ICertManageModule object
hr = pIManageModule->GetDescription( &bstrDesc );
if ( S_OK == hr )
    printf("Description is: %S\n", bstrDesc );

// free resources when done
if ( NULL != bstrDesc )
    SysFreeString( bstrDesc );
 

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in certmod.h.
  Import Library: Use certidl.lib.