Publishes this
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Document
object according to the specifications included in the specified publish template as modified by the contents of the publishOptions
parameter. This method returns the PublishRequest
object that is queued for this request. All publish requests are asynchronous, including copy operations, which do not transform the document. A publish request is always enqueued, and a copy of the PublishRequest
object is always returned to the caller. The publish template you specify, as well as any objects specified in the publish template itself, must reside on the same object store as this
object. Note that publishing to a document class containing a required binary- or object-valued property is not supported as there is no way to set these property values during publishing.
The
parameter is a string containing XML that specifies the publish options for the published document. See Publish Options XML for more information.
After a successful call to
, call the
method of the returned
object to submit the request to the publish queue.
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Function Publish( _ ByVal publishTemplate As IPublishTemplate, _ ByVal publishOptions As String _ ) As IPublishRequest |
C# |
---|
IPublishRequest Publish( IPublishTemplate publishTemplate, string publishOptions ) |
C++ |
---|
IPublishRequest Publish( IPublishTemplate publishTemplate, String publishOptions ) abstract |
J# |
---|
IPublishRequest Publish( IPublishTemplate publishTemplate, string publishOptions ) |
JScript |
---|
function Publish( publishTemplate : IPublishTemplate, publishOptions : String ) : IPublishRequest |
Parameters
- publishTemplate
- The
object to use for this publish operation.PublishTemplate
- publishOptions
- A string containing XML that specifies the publish options for the published document. Can be
, in which case the values for the publication name, output folder, and event action are as specified in the associated publish template.null
Return Value
The
object that is queued for this request.