IWMSContext::GetQwordValue

  • Article

banner art

Previous Next

IWMSContext::GetQwordValue

The GetQwordValue method retrieves a CURRENCY value from the specified context.

Syntax

  HRESULT GetQwordValue(
  LPCWSTR  pstrName,
  long  lNameHint,
  CURRENCY*  pqwValue,
  long  lOptions
);

Parameters

pstrName

[in] LPCWSTR specifying the name portion of the name-value pair in the context.

lNameHint

[in] long containing an optional key that can be used to more efficiently access a value.

pqwValue

[out] Pointer to a CURRENCY value. CURRENCY is a 64-bit integer type.

lOptions

[in] Reserved for future use.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Description
DISP_E_BADINDEX 0x8002000B The property specified by the pstrName parameter could not be found.
DISP_E_TYPEMISMATCH 0x80020005 The data type of the property specified by the pstrName parameter is not VT_CY or VT_UI8.
E_POINTER 0x80004003 The pqwValue parameter is NULL.

Example Code

//Declare variables.
HRESULT hr = S_OK;
QWORD qwSize = 0;

// Retrieve the size of the archive file, in bytes.
if (NULL != pArchiveContext)
{
    hr = pArchiveContext->GetQwordValue(
                                        WMS_ARCHIVE_FILE_SIZE,
                                        WMS_ARCHIVE_FILE_SIZE_ID,
                                        (CURRENCY * ) &qwSize,
                                        0
                                       );
    if (FAILED(hr)) goto EXIT;
}


EXIT:
    // TODO: Release temporary objects.

Requirements

Header: wmscontext.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.

See Also

Previous Next