IUri::GetPropertyDWORD method

Returns the specified numeric Uniform Resource Identifier (URI) property value.

Syntax

HRESULT GetPropertyDWORD(
  [in]  Uri_PROPERTY uriProp,
  [out] DWORD        *pdwProperty,
  [in]  DWORD        dwFlags
);

Parameters

  • uriProp [in]
    A value from the Uri_PROPERTY enumeration.

  • pdwProperty [out]
    Address of a DWORD that is set to the value of the specified property.

  • dwFlags [in]
    Property-specific flags. Must be set to 0.

Return value

Returns one of the following values:

Return code Description
S_OK

Success.

S_FALSE

The property is not defined.

E_INVALIDARG

pdwProperty is NULL, or property value is not a DWORD.

Remarks

IUri::GetPropertyDWORD was introduced in Windows Internet Explorer 7.

The uriProp parameter must be a numeric property. This method will fail if the specified property isn't a DWORD property.

This method will return S_FALSE and set pdwProperty to 0 if the specified property doesn't exist in the URI.

Requirements

Minimum supported client

Windows XP with SP2

Minimum supported server

Windows Server 2003 with SP1

Product

Internet Explorer 7

Header

Urlmon.h

IDL

Urlmon.idl

DLL

Urlmon.dll

See also

IUri

Reference

GetHostType

GetPort

GetPropertyBSTR

GetScheme

GetZone