CategoryReaderGetImageProcessingData Method (ConnectionId, SessionId, CategoryId) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns details about Image Processing settings for a single category.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public string GetImageProcessingData(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId
)

Parameters

connectionId
Type: ContentStudioConnectionId
A value that identifies the web site
sessionId
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
categoryId
Type: ContentStudio.DocumentCategoryId
The category to return data for.

Return Value

Type: String
Xml
<root>
    <status>0</status>
    <statustext>Success</statustext>
    <idata>
        <imageprocesslevel>3</imageprocesslevel>
        <imageprocessdata><lt;rootgt;&lt;ltimages&lt;gtlt;origgt;&lt;ltadj w="570" h="570" r="1" q="80" f="-1" s="0" sw="2" sr="0" /&lt;gtlt;thumbw=&quot;51" h="51" r="1" q="80" f="-1" s="0" sw="2" sr="0gt;&lt;ltimages&lt;gtlt;/rootgt;&lt;/imageprocessdataidata>
</root>
The Xml has the following following elements and meaning
ElementDescription
root/statusInteger: indicates the outcome of the call. Always 0 which indicates success.
root/statustextString: indicates the textual outcome of the call. Always 'Success'.
root/imageprocesslevelInteger: Indicates how image processing should be performed on images files in the category. For more information see CategoryManagerImageProcessingLevels.
root/imageprocessdataString: An embedded xml document that specifies settings used

The embedded xml has the following syntax

<root>
  <images>
    <orig />
    <adj w="570" h="570" r="1" q="80" f="-1" s="0" sw="2" sr="0" />
    <thumb w="51" h="51" r="1" q="80" f="-1" s="0" sw="2" sr="0" />
  </images>
</root>
The embedded xml has the following elements and attributes
Element/AttributeDescription
root/images/origSpecifies settings for the original image
root/images/adjSpecifies settings for the adjusted version of the image
root/images/thumbSpecifies settings for the thumbnail version of the image
The adj and thumb elements have the following attributes that specifies settings.
wMaximum height (in pixels) of the resulting image
hMaximum width (in pixels) of the resulting image
rBit (0 or 1). 1 to use normalized scaling, 0 otherwise.
qInteger: Quality (in percent) of the resulting image.
fInteger: Specifies the image filter to use. For more information see table below.
sInteger: Specifies the sharpening intensity. Value is between 1 and 100.
swInteger: Specifies the sharpening window (radius). Value is between 2 and 36.
srBit(0 or 1). 1 to use smart resizing; otherwise 0.
Image processing filter values
ValueAlgorithm name
0PassThruFilter
1TriangleFilter
2HermiteFilter
3BellFilter
4CubicBSplineFilter
5LanczosFilter(LanczosFilter.DefaultRadius)
6MitchellFilter
7NearestNeighborFilter
8HighQualityBilinearFilter
9BilinearFilter
10BilinearFilter
11BicubicFilter
Any other valueBellFilter
Exceptions

ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

ReadContainer permission on the category is required.
See Also

Reference