CreateBreadcrumb

Mon 01 January 2018

Syntax

CreateBreadcrumb(Back_label, history_ID, portal_ID, node_ID, component, page_ID, page_title, comp_mode [, comp_keys] [, qry_string])

Description

Note: This function has been deprecated and is retained for backward compatibility only.

Use the CreateBreadcrumb function to inject a history record containing application-specific data into the user’s Back button history stack. Optionally, the HTML representing ...

read more

CreateDirectory

Mon 01 January 2018

Syntax

CreateDirectory(path, [, pathtype])

Description

Use the CreateDirectory function to create the directory specified by path and any non-existent directories specified in path .

Important! The CreateDirectory function can be used to create a directory on an existing Windows share—for example, \\my_server\my_share\mydir. However, if the root of a ...

read more

CreateDocument

Mon 01 January 2018

Syntax

CreateDocument(DocumentKey | Package, DocumentName, Version)

Description

Use this method to instantiate a new Document object.

Important! When using this CreateDocument to instantiate a Document object, the object must stay in scope for as long as any child objects (Collection, Compound, or Primitive) generated from this Document object are referenced ...

read more

CreateDocumentKey

Mon 01 January 2018

Syntax

CreateDocumentKey(Package, DocumentName, Version)

Description

Use this method to instantiate a new DocumentKey object.

Parameters

Field or Control

Definition

Package

Specifies a document package as a string.

DocumentName

Specifies the name of the document as a string.

Note: The document name also becomes the root element name for the ...

read more

CreateException

Mon 01 January 2018

Syntax

CreateException(message_set, message_num, default_txt [, subslist])

where subslist is an arbitrary-length list of substitutions of undetermined (Any) data type to be substituted in the resulting text string, in the form:

substitution1 [, substitution2]. . .

Description

Use the CreateException function to create an exception object with the given properties. You can use this ...

read more

CreateJavaArray

Mon 01 January 2018

Syntax

CreateJavaArray(ElementClassName[], NumberOfElements)

Description

Use the CreateJavaArray function to create a Java array without knowing the number or value of the elements.

When you create an array in Java, you already know the number of elements in the array. If you do not know the number of elements in ...

read more

CreateJavaObject

Mon 01 January 2018

Syntax

CreateJavaObject(ClassName [ConstructorParams])

Where ConstructorParams has the form

argument1 [, argument2] . . . 

Description

Use the CreateJavaObject function to create a Java object that can be manipulated in PeopleCode.

Note: If you create a class that you want to call using GetJavaClass, it can be located in a directory specified in the ...

read more

CreateMCFIMInfo

Mon 01 January 2018

Syntax

CreateMCFIMInfo(UserID, Network)

Description

Use the CreateMCFIMInfo function to create an instance of the MCFIMInfo class. This is used to initiate the instant messaging session.

Parameters

Field or Control

Definition

UserID

Specify the PeopleSoft user as a string. This is the source user, or the user issuing the presence ...

read more

CreateMessage

Mon 01 January 2018

Syntax

CreateMessage(OPERATION.messagename [, message_type])

Description

Use the CreateMessage function to instantiate a message object that refers to a message definition associated with a service operation. The CreateMessage function sets the following properties for the resulting message object, based on the values set for the message definition:

  • Name

  • QueueName

  • Active ...

read more

CreateObject

Mon 01 January 2018

Syntax

CreateObject(str_class_name, create_par,  ...)

Where str_class_name either identifies:

  • A class by class name

  • A class of OLE Automation object in the form:

    app_name.object_name

Description

Use the CreateObject function to return an instance of a class. You can use this function to access an application class, a PeopleCode built-in object ...

read more