DataPA Enterprise Dashboard Controls API Reference
Publishes a Document (Report or Query) to DataPA Enterprise.

Namespace: DataPAClientConfig
Assembly: DataPAClientConfig (in DataPAClientConfig.dll) Version: 1.0.1.0 (1.0.1.0)

Syntax

C#
public bool PublishDocument(
	ref byte[] DocumentData,
	string ID,
	string Type,
	string FileName,
	string System,
	string Title,
	string Description,
	string Keywords,
	string Category,
	string Comments,
	string Author,
	string UserName,
	string Password,
	ref string[] ReqFieldNames,
	ref string[] ReqFieldLabels,
	ref string[] ReqFieldDescs,
	ref string[] ReqFieldTypes,
	ref string[] ReqFieldMands,
	ref string[] ReqFieldValues,
	ref string[] ReqFieldLookups,
	ref string[] ReqFieldFormats,
	ref string ErrMessage = ""
)
Visual Basic
Public Function PublishDocument ( 
	ByRef DocumentData As Byte(),
	ID As String,
	Type As String,
	FileName As String,
	System As String,
	Title As String,
	Description As String,
	Keywords As String,
	Category As String,
	Comments As String,
	Author As String,
	UserName As String,
	Password As String,
	ByRef ReqFieldNames As String(),
	ByRef ReqFieldLabels As String(),
	ByRef ReqFieldDescs As String(),
	ByRef ReqFieldTypes As String(),
	ByRef ReqFieldMands As String(),
	ByRef ReqFieldValues As String(),
	ByRef ReqFieldLookups As String(),
	ByRef ReqFieldFormats As String(),
	Optional ByRef ErrMessage As String = ""
) As Boolean
Visual C++
public:
virtual bool PublishDocument(
	array<unsigned char>^% DocumentData, 
	String^ ID, 
	String^ Type, 
	String^ FileName, 
	String^ System, 
	String^ Title, 
	String^ Description, 
	String^ Keywords, 
	String^ Category, 
	String^ Comments, 
	String^ Author, 
	String^ UserName, 
	String^ Password, 
	array<String^>^% ReqFieldNames, 
	array<String^>^% ReqFieldLabels, 
	array<String^>^% ReqFieldDescs, 
	array<String^>^% ReqFieldTypes, 
	array<String^>^% ReqFieldMands, 
	array<String^>^% ReqFieldValues, 
	array<String^>^% ReqFieldLookups, 
	array<String^>^% ReqFieldFormats, 
	String^% ErrMessage = L""
) sealed

Parameters

DocumentData
Type: array<System..::..Byte>[]()[][]%
ID
Type: System..::..String
ID of the document to be published.
Type
Type: System..::..String
FileName
Type: System..::..String
System
Type: System..::..String
Title
Type: System..::..String
The title of the document.
Description
Type: System..::..String
Description of the document.
Keywords
Type: System..::..String
Keywords of the document.
Category
Type: System..::..String
Comments
Type: System..::..String
Author
Type: System..::..String
UserName
Type: System..::..String
Password
Type: System..::..String
ReqFieldNames
Type: array<System..::..String>[]()[][]%
ReqFieldLabels
Type: array<System..::..String>[]()[][]%
ReqFieldDescs
Type: array<System..::..String>[]()[][]%
ReqFieldTypes
Type: array<System..::..String>[]()[][]%
ReqFieldMands
Type: array<System..::..String>[]()[][]%
ReqFieldValues
Type: array<System..::..String>[]()[][]%
ReqFieldLookups
Type: array<System..::..String>[]()[][]%
ReqFieldFormats
Type: array<System..::..String>[]()[][]%
ErrMessage (Optional)
Type: System..::..String%
Any error messages that occured during the publish.

Return Value

Type: Boolean
True if the object is published to DataPA Enterprise.

Remarks