IUri::GetPropertyLength method

Returns the string length of the specified Uniform Resource Identifier (URI) property. Call this function if you want the length but don't necessarily want to create a new BSTR.

Syntax

HRESULT GetPropertyLength(
  [in]  Uri_PROPERTY uriProp,
  [out] DWORD        *pcchProperty,
  [in]  DWORD        dwFlags
);

Parameters

uriProp [in]

A value from the Uri_PROPERTY enumeration.

pcchProperty [out]

Address of a DWORD that is set to the length of the value of the string property excluding the NULL terminator.

dwFlags [in]

One of the following property-specific flags, or zero.

Uri_DISPLAY_NO_FRAGMENT (0x00000001)

Uri_PROPERTY_DISPLAY_URI: Exclude the fragment portion of the URI, if any.

Uri_PUNYCODE_IDN_HOST (0x00000002)

Uri_PROPERTY_ABSOLUTE_URI, Uri_PROPERTY_DOMAIN, Uri_PROPERTY_HOST: If the URI is an IDN, always display the hostname encoded as punycode.

Uri_DISPLAY_IDN_HOST (0x00000004)

Uri_PROPERTY_ABSOLUTE_URI, Uri_PROPERTY_DOMAIN, Uri_PROPERTY_HOST: Display the hostname in punycode or Unicode as it would appear in the Uri_PROPERTY_DISPLAY_URI property.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

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

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

This method will return S_FALSE and set pcchProperty to 0 if the URI doesn't contain the specified property.

Requirements

See also

IUri

IUri::GetPropertyBSTR