(0) exportieren Drucken
Alle erweitern
EN
Dieser Inhalt ist in Ihrer Sprache leider nicht verfügbar. Im Folgenden finden Sie die englische Version.

IBackgroundCopyJob::GetDescription method

Retrieves the description of the job.

Syntax


HRESULT GetDescription(
  [out]  LPWSTR *ppDescription
);

Parameters

ppDescription [out]

Null-terminated string that contains a short description of the job. Call the CoTaskMemFree function to free ppDescription when done.

Return value

This method returns the following HRESULT values, as well as others.

Return codeDescription
S_OK

Description of the job was successfully retrieved.

E_INVALIDARG

The parameter, ppDescription, cannot be NULL.

 

Examples

The following example shows how to retrieve the description property value from the job. The example assumes the IBackgroundCopyJob interface pointer points to a valid job.


HRESULT hr;
IBackgroundCopyJob* pJob;
WCHAR* pszDescription = NULL;

hr = pJob->GetDescription(&pszDescription);
if (SUCCEEDED(hr))
{
  //Do something with the description.

  CoTaskMemFree(pszDescription);
}

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

IBackgroundCopyJob::SetDescription

 

 

Community-Beiträge

HINZUFÜGEN
Anzeigen:
© 2014 Microsoft