Methods that deal specifically with DMA object instance identifiers.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaOIID::GetDocSpaceId (
pDmaString pOIID,
pDmaId pDocSpaceId)
Parameters
Name | Mode | Description |
pOIID | input | Pointer to the OIID |
pDocSpaceId | output | Pointer to a caller-allocated DmaId into which the docspace-id component of the OIID input parameter is extracted. |
This method extracts the docspace-id from the OIID input parameter and returns the docspace-id in a DmaId structure.
There is a small well defined set of DMA return codes returned from this method. There is no DMA supplied mechanism for mapping these return codes into a meaningful message (e.g., IdmaSystem::GetResultCodeDescription), until a DMA System object becomes available
Return Values
Name | Description |
DMARC_BAD_OIID | The supplied buffer does not contain a valid OIID. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_OK | (S_OK) Success. |
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaOIID::GetGuid (
pDmaString pOIID,
pDmaId pObjectGUID)
Parameters
Name | Mode | Description |
pOIID | input | Pointer to a DMA OIID |
pObjectGUID | output | Pointer to a DmaId into which the object-guid component of the OIID input parameter is extracted |
This method extracts the optional object-guid from the OIID input parameter and returns the object-guid in a DmaId structure.
There is a small well defined set of DMA return codes returned from this method. There is no DMA supplied mechanism for mapping DMA return codes into a meaningful message (e.g., IdmaSystem::GetResultCodeDescription), until a DMA System object becomes available.
Return Values
Name | Description |
DMARC_BAD_OIID | The supplied buffer does not contain a valid OIID. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_NOT_FOUND | Requested item not found. |
DMARC_OK | (S_OK) Success. |
Support for this method is optional.
Syntax
DmaRC IdmaOIID::GetObjectIdText (
pDmaString pOIID,
ppDmaString ppObjectText)
Parameters
Name | Mode | Description |
pOIID | input | The OIID to be parsed. |
ppObjectText | output | The returned object Id component |
This will extract the object identifier component from an OIID, if it is possible to successfully parse and locate this component.
Return Values
Name | Description |
DMARC_BAD_OIID | The supplied buffer does not contain a valid OIID. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_NO_MEMORY | (E_OUTOFMEMORY) Insufficient memory to complete the operation. |
DMARC_NOT_FOUND | Requested item not found. |
DMARC_OK | (S_OK) Success. |
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaOIID::GetSystemId (
pDmaString pOIID,
pDmaId pSystemId)
Parameters
Name | Mode | Description |
pOIID | input | Pointer to the OIID |
pSystemId | output | Pointer to a DmaId into which the system-id component of the OIID input parameter is extracted |
This method extracts the system-id from the OIID input parameter and returns the system-id in a DmaId structure.
There is a small well defined set of DMA return codes returned from this method. There is no DMA supplied mechanism for mapping these return codes into a meaningful message (e.g., IdmaSystem::GetResultCodeDescription), until a DMA System object becomes available.
Return Values
Name | Description |
DMARC_BAD_OIID | The supplied buffer does not contain a valid OIID. |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_OK | (S_OK) Success. |