This is the specialized interface for the DMA System object. It provides access to Document Spaces and methods that deal with multiple Document Spaces. It also provides some infrastructure services, such as access to the memory management mechanism.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaSystem::ConnectDocSpace (
pDmaId pDocSpaceId,
pDmaString pLocaleName,
DMA_REFIID riid,
pDmapv ppIDocSpace)
Parameters
Name | Mode | Description |
pDocSpaceId | input | The DmaId which identifies the document space for which an object is to be instantiated. |
pLocaleName | input | The name of the locale to be used by the returned document space instance. If this parameter is NULL, the document space is to employ its default locale. If this parameter is non-NULL and does not correspond to a locale supported by the document space, the returned instance will utilize the document space's default locale. |
riid | input | Interface Identifier for the desired interface on the resulting DMA object |
ppIDocSpace | output | Reference to the requested interface for the DocSpace object; NULL if the operation is unsuccessful. |
Returns an interface to a (usually unauthenticated) DMA DocSpace object representing the identified DMA Document Space. If the operation succeeds, a new DocSpace object is instantiated, representing a point-of-access view of the identified document space. Each DocSpace interface returned by IdmaSystem::ConnectDocSpace is for a distinct instance of a DMA DocSpace object (in the same sense that EnumerationOfObject delivers distinct instances according to the DMA Object Model).
In general, the IdmaAuthentication interface must be exercised on the returned DMA DocSpace object before the object can be used for anything other than inspecting non-object valued properties..
Return Values
Name | Description |
DMARC_BAD_DOC_SPACE | There is no available document space with the specified DmaId |
DMARC_BAD_INTERFACE | (E_NOINTERFACE) The requested interface is not supported by this object. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_NO_MEMORY | (E_OUTOFMEMORY) Insufficient memory to complete the operation. |
DMARC_OK | (S_OK) Success. |
DMARC_UNEXPECTED | (E_UNEXPECTED) An unexpected error occurred. |
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaSystem::EnumerateDocSpaces (
DMA_REFIID riid,
pDmapv ppIEnumOfDocSpace)
Parameters
Name | Mode | Description |
riid | input | Interface Identifier for the desired interface on resulting object. |
ppIEnumOfDocSpace | output | Returns a reference to the requested interface or NULL if unsuccessful. |
The IdmaSystem::EnumerateDocSpaces function returns an interface (typically IdmaEnumOfObject) to a DMA object which the caller can use to enumerate DMA Document Space objects accessible via the System object. The DocSpace objects delivered by the enumerator are in the same state as if ConnectDocSpace had been called, using the locale and character set encoding in effect for the System object. Therefore, in general, the IdmaAuthentication interface must be exercised on the returned objects before they can be used for anything other than inspecting the DocSpace's non-object valued properties.
If the returned object does not support the interface specified by riid, the operation will fail and the result code DMARC_BAD_INTERFACE will be returned. In case the operation is successful, the returned interface must be released using the method IUnknown::Release.
Return Values
Name | Description |
DMARC_BAD_INTERFACE | (E_NOINTERFACE) The requested interface is not supported by this object. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_NOT_AUTHENTICATED | The user is not authenticated. |
DMARC_OK | (S_OK) Success. |
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaSystem::GetResultCodeDescription (
DmaRC rcResultCode,
ppDmaString ppResultCodeDesc)
Parameters
Name | Mode | Description |
rcResultCode | input | A result code that may be returned from a DMA method. |
ppResultCodeDesc | output | Returns a string that describes the selected result code. |
Returns a string that contains a textual description of the result code that is passed in to the function. The description will be given in the operative locale for the System object.
Return Values
Name | Description |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_BAD_RC | Invalid Result Code. |
DMARC_OK | (S_OK) Success. |