PublishControl.GetItem Method (ConnectionId, SessionId, CSFileObjectTypes, Int32)

PublishControlGetItem Method (ConnectionId, SessionId, CSFileObjectTypes, Int32)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns the whether the UsePublishDate functionality is enabled on a certain object

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

Syntax

public string GetItem(
	ConnectionId connectionId,
	SessionId sessionId,
	CSFileObjectTypes objectType,
	int objectId
)

Public Function GetItem ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	objectType As CSFileObjectTypes,
	objectId As Integer
) As String

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).
objectType: Type: ContentStudio.DocumentCSFileObjectTypes
The type of object to test.
objectId: Type: SystemInt32
The object to test.

Return Value

Type: String

Copy

Return XML syntax:
             <br /><br />
            <root>
              <status>0</status>
              <statustext>Success</statustext>
              <usepublishdate>0</usepublishdate>
            </root>

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the object is required.

Reference

PublishControl Class

GetItem Overload

ContentStudio.Document Namespace