IWMSContext::GetLongValue

  • Article

banner art

Previous Next

IWMSContext::GetLongValue

The GetLongValue method retrieves a long value from the context.

Syntax

  HRESULT GetLongValue(
  LPCWSTR  pstrName,
  long  lNameHint,
  long*  plValue,
  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.

plValue

[out] Pointer to the long value portion of the name-value pair.

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_I4.
E_POINTER 0x80004003 The plValue parameter is NULL.

Example Code

// Declare variables.
BOOL fIsUnSeekable = FALSE;

// Determine whether content can be skipped.
if (NULL != pContext)
{
    hr = pContext->GetLongValue(
                                WMS_CONTENT_DESCRIPTION_NO_SKIP,
                                WMS_CONTENT_DESCRIPTION_NO_SKIP_ID,
                                ( LONG * )&fIsUnSeekable,
                                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