SHPropertyBag_WriteRECTL

This function asks a property bag to write the members of a RECTL structure as values of a set of named properties.

Declaration

HRESULT
SHPropertyBag_WriteRECTL (
    IPropertyBag *ppb,
    LPCWSTR pszPropName,
    LPCRECTL pValue);

Parameters

The ppb argument provides the address of an IPropertyBag interface.

The pszPropName argument provides the address of a null-terminated Unicode string that names the property pair.

The pValue argument provides the address of the RECTL structure.

Return Value

The function returns zero for success, else an error code.

Behaviour

If any of the ppb, pszPropName and pValue arguments are NULL, the function fails, with E_INVALIDARG as the error code. The names of the four properties are formed by appending “.left”, “.right”, “.top” and “.bottom” to the base name of the set. If this cannot be done within MAX_PATH characters, the function fails, with E_FAIL as the error code. The left, right, top and bottom members of the RECTL become respectively the LONG values of the “.left”, “.right”, “.top” and “.bottom” properties. If the function cannot write each property (using SHPropertyBag_WriteLONG), it fails.

Availability

The SHPropertyBag_WriteRECTL function is exported from SHLWAPI as ordinal 524 in version 6.00.

Though this function dates from 2001, it was still not documented by Microsoft in the MSDN Library at least as late as the CD edition dated January 2004.